openapi: 3.2.0 info: title: Communications Comms APIs API description: Unified Communications APIs version: '1.0' servers: - url: https://api.everbridge.net/managerapps/communications/v1 tags: - name: Comms APIs paths: /: post: deprecated: true tags: - Comms APIs operationId: cem-comms-launch summary: Launch Communication description: Launch a communication. requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/LaunchCommRequest' - $ref: '#/components/schemas/PreviewCommRequest' examples: Sending a communication to a set of individual contacts: summary: Sending a communication to a set of individual contacts value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Live priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL recipients: contacts: - type: ExternalId externalId: jsmith1 - type: Id id: '873461568734615' - type: Name firstName: Jimi lastName: Hendrix description: Earthquake in Michigan. Sending a communication to a set of contact groups: summary: Sending a communication to a set of contact groups value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Live priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL recipients: groups: - type: Id id: '873461568734615' - type: Name name: MVPs Sending a communication to contacts that match a contact rule (filter): summary: Sending a communication to contacts that match a contact rule (filter) value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Live priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL recipients: rules: - type: Id id: '873461568734615' - type: Name name: Michigan Factory Employees Previewing a communication with custom settings: summary: Previewing a communication with custom settings value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Preview priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL settings: sender: email: name: Mitten Circus Attractions Inc. replyToEmail: call4clowns@example.com delivery: paths: - type: Prompt prompt: Email ttl: PT1H recipientInteraction: confirm: false Sending a communication with all types of public messages: summary: Sending a communication with all types of public messages value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Live priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL publicMessages: - type: WebWidget title: subject body: eww body stream: Widget 1 duration: P0Y0M0DT1H0M0S ewwEndDate: '2024-07-02T20:06:09.734385Z' - title: subject body: alert us body alertUsRestSettings: - id: 1880407012278273 groups: - groupId: '51' groupName: '!Unique-COVID-19 Alert' profileId: '26' profileName: '1. HPSA / Everbridge Test ' duration: '10' alertUsSetting: 1880407012278274 type: AlertUs alertUsSettingId: 1880407012278274 - type: MemberPortal title: subject body:
member portal body
includeSelectedMapShape: true - type: Everbridge Community - type: SocialMedia tokenIds: - '1941670425788417' - '1940570914160642' incLink: true customContents: - type: Facebook title: subject body: facebook body iamgeId: 6684699301a19600834544ef-Screenshot 2024-07-03 at 8.28.40 AM.png - type: Twitter title: subject body: twitter body imageId: 6684699301a19600834544ef-Screenshot 2024-07-03 at 8.28.40 AM.png webPageMessage:
twitter web page message
- type: Network title: subject body: everbridge network body networkEffectTypes: - PUBLIC - NETWORK_GROUP affectedAreas: '[{"class":"com.everbridge.platform.gis.model.GeoPolygon","points":[{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.44684600829565,"y":39.48112079193548},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-109.33844757079812,"y":37.59070096979298},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.57868194579827,"y":35.14952743589674},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.44684600829565,"y":39.48112079193548}],"shell":{"class":"com.everbridge.platform.gis.model.GeoLinearRing","points":[{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.44684600829565,"y":39.48112079193548},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-109.33844757079812,"y":37.59070096979298},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.57868194579827,"y":35.14952743589674},{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.44684600829565,"y":39.48112079193548}]},"holes":null,"boudingBox":{"class":"com.everbridge.platform.gis.model.GeoBox","upperRight":{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-109.33844757079812,"y":39.48112079193548},"lowerLeft":{"class":"com.everbridge.platform.gis.model.GeoPoint","x":-115.57868194579827,"y":35.14952743589674}},"include":false,"isCircle":false}]' groupIds: - 313365108883458 - 313365108883457 - receiveUrls: - http://dev.alertus.com:8280/alertusmw/services/AlertusMiddlewareBasic?wsdl - http://dev.alertus.com:8280/alertusmw/services/A2lertusMiddlewareBasic?wsdl - http://dev.alertus.com:81280/alertusmw/services/AlertusMiddlewareBasic?wsdl - https://webhook.site/70cb36e5-a1ff-4164-8209-3419ddfc2b8c?aaa=123123 - https://webhook.site/70cb36e5-a1ff-4164-8209-3419ddfc2b8c - https://pokeapi.co/api/v2/pokemon/charizard - https://webhook.site/70cb36e5-a1ff-4164-8209-3419ddfc2b8ce - https://pokeapi.co/api/v2/pokemon/charizarde - https://webhook.site/398b9806-bdeb-40ec-a469-f77067cd2f25 - https://webhook.site/5e07de0e-507b-4f7b-8291-66cf83ad289a - https://webhook-test.com/0063eee5345b916f4a4cd53073937520 - https://pokeapi.co/api/v2/pokemon/ditto title: subject body: web posting body type: GenericOneWay - type: AudioBulletinBoard title: '' body: '' settingId: 0 expires: P0Y0M1DT0H0M0S - type: CAPPublicMessage capCategory: Environmental capEventType: Air Pollution capEventCode: LAE capSeverity: Severe capUrgency: Expected capCertainty: Likely recipients: contacts: - type: ExternalId externalId: jsmith1 - type: Id id: '873461568734615' - type: Name firstName: Jimi lastName: Hendrix Sending a communication to a set of public users: summary: Sending a communication to a set of public users value: title: May 2nd, 2015 - Earthquake - Galesburg, Michigan mode: Live publicSafety: true priority: Normal eventType: Earthquake launchedFrom: API message: contents: - type: Textual contentType: text/plain title: Earthquake in Galesburg, Michigan content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication. paths: - CATEGORY:EMAIL recipients: publicUsers: - type: SemanticQuery command: type: SemanticQuery subscribedToIds: - 6858fdb7d988820e9d08db7b forZipCodes: - '82801' sendToAorSubscriptions: true description: Earthquake in Michigan. required: true responses: '200': description: The communication preview was generated successfully. content: application/json: schema: $ref: '#/components/schemas/PreviewCommResponse' '201': description: The communication was created successfully. content: application/json: schema: $ref: '#/components/schemas/CommsResponse' examples: Successful creation of a communication: summary: Successful creation of a communication value: id: 73ef9c42-df40-41c8-9b2d-6618ed5c31c1 '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' examples: Single validation error: summary: Single validation error value: type: /client-error/invalid-parameter title: Bad Request status: 400 detail: 'The "Field Name #1" field must not be empty.' instance: /cem-comms Multiple validation errors: summary: Multiple validation errors value: type: /client-error/invalid-parameter title: Bad Request status: 400 detail: 'The "title" field must not be empty. The "eventType" field must not be empty. The "Field Name #1" field must not be empty.' instance: /cem-comms '401': description: The token provided does not have permission to create a new communication. '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' examples: An internal server error has occurred: summary: An internal server error has occurred value: type: about:blank title: Internal Server Error status: 500 detail: null instance: /cem-comms security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications responses: default: statusCode: '201' passthroughBehavior: when_no_match connectionType: VPC_LINK get: deprecated: true tags: - Comms APIs operationId: getCem-comms summary: List Communications description: List communications based on the filter criteria. Only communications that match all filter criteria will be returned. parameters: - in: query name: threadStatus schema: type: string enum: - ACTIVE - INACTIVE description: Filter the record set by the thread status of the communication. If `threadStatus` is not provided, then the record set will include all communications. - in: query name: status schema: type: string enum: - ACTIVE - IN_PROGRESS - SENT - STOPPED - EXPIRED_ARCHIVED description: "Filter the record set by the status of the communication:\n * `ACTIVE`: Active communications that are currently sending notifications and/or waiting for responses.\n * `IN_PROGRESS`: Communications that have been submitted but not yet processed.\n * `SENT`: Communications that have sent at least one notification.\n * `STOPPED`: Communications that have been stopped manually by a user.\n * `EXPIRED_ARCHIVED`: Communications that have run their full course or otherwise been archived.\n\n If a `status` is not provided, then the record set will include communications with any status." - in: query name: mode schema: type: string enum: - LIVE - SIMULATION - PREVIEW description: "Filter the record set by the notification mode set when it was launched. Please see the [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms) endpoint for more information on `mode`.\n If `mode` is not specified, then the record set will include all communications with any `mode`." - in: query name: types schema: type: array items: type: string enum: - Communication - Incident - Notification description: Filter the records returned by the type of communication. If `types` is not specified, then the record set will include all types of communications. - in: query name: fromDate schema: type: string format: date-time description: Start date as an ISO 8601-compliant value to filter the record set by. - in: query name: toDate schema: type: string format: date-time description: End date as an ISO 8601-compliant value to filter the record set by. - in: query name: dateType schema: type: string enum: - CREATED - UPDATED - SENT description: Specifies the field that `fromDate` and `toDate` should apply to. Defaults to `CREATED`. This parameter is ignored if neither `fromDate` nor `toDate` are specified. - in: query name: contextId schema: type: string description: The ID of a contextual object that may have been used to launch a communication. View available contexts using the [Context API](https://developers.everbridge.net/internal/reference/getcontexts). - in: query name: title schema: type: string description: Filters by the title of the communication. Returns any communication that contains any word provided in `title`. - in: query name: sentBy schema: type: string description: Filter by an ID of a user that can launch communications. - in: query name: tags schema: type: array items: type: string description: Filter by one or more tags assigned to a communication. Returns any communication that matches at least one of the provided tags. - in: query name: eventType schema: type: array items: type: string description: Filter by one or more event type values, such as `General` or `Flood`. Values are matched as an OR group. - in: query name: sortBy schema: type: string enum: - CREATED - EVENTTYPE - NAME - PRIORITY - SENT description: 'The field to sort the result set by. See `sortDirection` for adjusting the order in which the result set is sorted. Defaults to `CREATED`.' - in: query name: sortDirection schema: type: string enum: - ASC - ASCENDING - DESC - DESCENDING description: 'The order by which to sort the result set by. `ASC` and `ASCENDING` have the same effect of ordering the values in ascending order; additionally, `DESC` and `DESCENDING` also have the same effect of ordering the values in descending order. See `sortBy` for details on changing which field is used in sorting. Defaults to `DESCENDING`.' - in: query name: pageSize schema: type: integer format: int32 minimum: 1 maximum: 100 description: The size of each page of search results. Defaults to ten records. - in: query name: pageNumber schema: type: integer format: int32 minimum: 1 description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 1. responses: '200': description: The query was executed successfully. content: application/json: schema: $ref: '#/components/schemas/CommPaginatedResponse' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query connectionType: VPC_LINK /{commId}: patch: deprecated: true tags: - Comms APIs summary: Update communication description, title, eventType and active description: Update the description, title, eventType and active properties of an existing communication. operationId: patchCem-commsCommid parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to update. requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchCommRequest' required: true responses: '202': description: The communication has been updated successfully. content: application/json: schema: $ref: '#/components/schemas/CommDetail' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to update an existing communication. '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId} responses: default: statusCode: '202' requestParameters: integration.request.path.commId: method.request.path.commId passthroughBehavior: when_no_match connectionType: VPC_LINK get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommid summary: Get Communication description: Get a single communication by its ID. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/CommDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId} connectionType: VPC_LINK /resend: post: deprecated: true tags: - Comms APIs operationId: postResendCem-comms summary: Resend Communication description: Resend a communication. parameters: - in: query name: commId schema: type: string required: true description: The ID of the communication to resend. requestBody: content: application/json: schema: $ref: '#/components/schemas/ResendCommRequest' examples: Resending a communication to a set of individual contacts: summary: Sending a communication to a set of individual contacts value: launchedFrom: API recipients: contacts: - type: ExternalId externalId: jsmith1 - type: Id id: '873461568734615' - type: Name firstName: Jimi lastName: Hendrix Resending a communication to a set of contact groups: summary: Sending a communication to a set of contact groups value: launchedFrom: API recipients: groups: - type: Id id: '873461568734615' - type: Name name: MVPs Resending a communication to contacts that match a contact rule (filter): summary: Sending a communication to contacts that match a contact rule (filter) value: launchedFrom: API recipients: rules: - type: Id id: '873461568734615' - type: Name name: Michigan Factory Employees Previewing a communication with custom settings: summary: Previewing a communication with custom settings value: mode: Preview launchedFrom: API required: true responses: '201': description: The communication was created successfully. content: application/json: schema: $ref: '#/components/schemas/CommsResponse' examples: Successful creation of a communication: summary: Successful creation of a communication value: id: 73ef9c42-df40-41c8-9b2d-6618ed5c31c1 '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' examples: Single validation error: summary: Single validation error value: type: /client-error/invalid-parameter title: Bad Request status: 400 detail: 'The "Field Name #1" field must not be empty.' instance: /cem-comms Multiple validation errors: summary: Multiple validation errors value: type: /client-error/invalid-parameter title: Bad Request status: 400 detail: 'The "title" field must not be empty. The "eventType" field must not be empty. The "Field Name #1" field must not be empty.' instance: /cem-comms '401': description: The token provided does not have permission to create a new communication. '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' examples: An internal server error has occurred: summary: An internal server error has occurred value: type: about:blank title: Internal Server Error status: 500 detail: null instance: /cem-comms security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/resend responses: default: statusCode: '201' passthroughBehavior: when_no_match connectionType: VPC_LINK /{commId}/stop: patch: deprecated: true tags: - Comms APIs operationId: patchStopCem-comms summary: Stop Communication description: Stop a communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to stop. responses: '200': description: The communication was stopped successfully. content: application/json: schema: $ref: '#/components/schemas/StopCommsResponse' examples: Successful stop of a communication: summary: Successful stop of a communication value: id: 73ef9c42-df40-41c8-9b2d-6618ed5c31c1 '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to create a new communication. '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' examples: An internal server error has occurred: summary: An internal server error has occurred value: type: about:blank title: Internal Server Error status: 500 detail: null instance: /cem-comms security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/stop responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId passthroughBehavior: when_no_match connectionType: VPC_LINK /{commId}/publish-options: patch: deprecated: true tags: - Comms APIs operationId: deactivateCem-commsPublishOptionMessage summary: Deactivate or expire a single communication publish option message description: Deactivate or expire a single communication publish option message parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication that will be deactivated or expired for a publish option message. requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivatePublishOptionVO' examples: Deactivate comms publish option AudioBulletinBoard message: summary: Deactivate comms publish option AudioBulletinBoard message value: path: AudioBulletinBoard status: Deactivate Deactivate comms publish option WebWidget message: summary: Deactivate comms publish option WebWidget message value: path: WebWidget status: Deactivate Deactivate comms publish option MemberPortal message: summary: Deactivate comms publish option MemberPortal message value: path: MemberPortal status: Deactivate required: true responses: '200': description: The comm publish option message was deactivated successfully. content: application/json: schema: $ref: '#/components/schemas/PublishOptionMessageDeactivatedResponse' examples: Successfully deactivated a Member Portal message: summary: Successfully deactivated a Member Portal message value: path: MemberPortal status: Deactivated Successfully deactivated an AudioBulletinBoard message: summary: Successfully deactivated an AudioBulletinBoard message value: path: AudioBulletinBoard status: MANUALEXPIRE expireDateTime: 2024-12-24T14:58:501Z Successfully deactivated a WebWidget message: summary: Successfully deactivated a WebWidget message value: path: WebWidget status: Deactivated deactivatedDate: 2024-12-24T14:58:501Z deactivatedBy: Ranen Liu '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to deactivate a comms publish option path message. '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/publish-options connectionType: VPC_LINK get: deprecated: true tags: - Comms APIs operationId: getCem-commsPublishOptionPathDetail summary: Retrieve a single communication publish option path detail description: Retrieve a single communication publish option path detail parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication for which to retrieve the publish option path detail. - in: query name: publishOptionPath required: true schema: type: string enum: - AudioBulletinBoard - WebWidget - MemberPortal - SocialMedia description: Communication publish option path you want to fetch. responses: '200': description: The communication publish option path detail info. content: application/json: schema: $ref: '#/components/schemas/PublishOptionPathResponse' examples: Retrieving communication publish option path AudioBulletinBoard detail: summary: Retrieving communication publish option path AudioBulletinBoard detail value: path: AudioBulletinBoard status: ACTIVE futureExpireDateTime: '2025-01-10T01:32:10.027Z' Retrieving communication publish option path MemberPortal detail: summary: Retrieving communication publish option path MemberPortal detail value: path: MemberPortal includeSelectedMapShape: true status: Deactivated Retrieving communication publish option path WebWidget detail: summary: Retrieving communication publish option path WebWidget detail value: path: WebWidget name: Widget 1 durationType: Set by Calendar status: Expired expirationDate: '2025-01-05T01:32:10.027Z' Retrieving communication publish option path SocialMedia detail: summary: Retrieving communication publish option path SocialMedia detail value: path: SocialMedia twitter: - twitterName: '@xxxxxxx11111' status: Failed errorMessage: twitter v2 authentication error errorCode: 401 - twitterName: '@xxxxxxx123432' status: Failed errorMessage: twitter v2 authentication error errorCode: 401 facebook: - Jim Green - Smith Wang - Kate Wang '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/publish-options connectionType: VPC_LINK /{commId}/confirmation-result: post: deprecated: true tags: - Comms APIs operationId: postCem-commsConfirmationResult summary: Generate a resultset based on communication confirmations description: Generates one or more resultsets, to be used for sending a follow-up communication to recipients who have provided specified responses. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication recipients reacted to. requestBody: content: application/json: schema: type: array description: Confirmations to include in results. items: type: string description: The confirmation to include in results. responses: '200': description: The resultset has been created. content: application/json: schema: type: array description: Set of applicable resultsets. items: type: string description: The sets to include in new communication. examples: Successfully created results: summary: Successfully created results value: - evbg+resultset:contacts:234817a246-4f2f-4a4f-8b8f-4f2f4a4f8b8f-confirmation-246a735b:1143697283497 '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to generate a result set from the communication. '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/confirmation-result connectionType: VPC_LINK /{commId}/operator-confirmation: post: deprecated: true tags: - Comms APIs operationId: postCem-commsOperatorConfirmation summary: Confirm operators for a communication description: Confirms operator responses for the specified communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to confirm. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OperatorConfirmationRequest' responses: '200': description: Operator confirmation processed. content: application/json: schema: $ref: '#/components/schemas/OperatorConfirmationResponse' '404': description: Communication not found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. This may not always return a response body. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/operator-confirmation connectionType: VPC_LINK /comm: post: tags: - Comms APIs operationId: comm-launch summary: Launch Communication description: Launch a communication. requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/LaunchCommRequest' - $ref: '#/components/schemas/PreviewCommRequest' required: true responses: '200': description: The communication preview was generated successfully. content: application/json: schema: $ref: '#/components/schemas/PreviewCommResponse' '201': description: The communication was created successfully. content: application/json: schema: $ref: '#/components/schemas/CommsResponse' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to create a new communication. '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications responses: default: statusCode: '201' passthroughBehavior: when_no_match connectionType: VPC_LINK get: tags: - Comms APIs operationId: getComm-list summary: List Communications description: List communications based on the filter criteria. Only communications that match all filter criteria will be returned. parameters: - in: query name: threadStatus schema: type: string enum: - ACTIVE - INACTIVE description: Filter the record set by the thread status of the communication. If `threadStatus` is not provided, then the record set will include all communications. - in: query name: status schema: type: string enum: - ACTIVE - IN_PROGRESS - SENT - STOPPED - EXPIRED_ARCHIVED description: Filter the record set by the status of the communication. - in: query name: mode schema: type: string enum: - LIVE - SIMULATION - PREVIEW description: Filter the record set by the notification mode. - in: query name: types schema: type: array items: type: string enum: - Communication - Incident - Notification description: Filter the records returned by the type of communication. - in: query name: fromDate schema: type: string format: date-time description: Start date as an ISO 8601-compliant value to filter the record set by. - in: query name: toDate schema: type: string format: date-time description: End date as an ISO 8601-compliant value to filter the record set by. - in: query name: dateType schema: type: string enum: - CREATED - UPDATED - SENT description: Specifies the field that `fromDate` and `toDate` should apply to. - in: query name: contextId schema: type: string description: The ID of a contextual object. - in: query name: title schema: type: string description: Filters by the title of the communication. - in: query name: sentBy schema: type: string description: Filter by an ID of a user that can launch communications. - in: query name: responseId schema: type: string description: Filter by response management ID, which is resolved through the crisis event service before querying communications. - in: query name: tags schema: type: array items: type: string description: Filter by one or more tags. - in: query name: eventType schema: type: array items: type: string description: Filter by one or more event type values, such as `General` or `Flood`. Values are converted to `eventType:` tags and matched as an OR group. Supports repeated query parameters or comma-separated values. - in: query name: priority schema: type: array items: type: string enum: - NORMAL - HIGHPRIORITY - LIFETHREATENING description: Filter by one or more communication priorities, matched as an OR group. If `priority` is not provided, then the record set will include communications with any priority. Supports repeated query parameters (e.g. `priority=NORMAL&priority=HIGHPRIORITY`). - in: query name: sortBy schema: type: string enum: - CREATED - EVENTTYPE - NAME - PRIORITY - SENT description: The field to sort the result set by. - in: query name: sortDirection schema: type: string enum: - ASC - ASCENDING - DESC - DESCENDING description: The order by which to sort the result set. - in: query name: pageSize schema: type: integer format: int32 minimum: 1 maximum: 100 description: The size of each page of search results. - in: query name: pageNumber schema: type: integer format: int32 minimum: 1 description: The requested page number. responses: '200': description: The query was executed successfully. content: application/json: schema: $ref: '#/components/schemas/CommPaginatedResponse' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query connectionType: VPC_LINK /comm/{commId}: patch: tags: - Comms APIs operationId: patchComm-commId summary: Update communication description, title, eventType and active description: Update the description, title, eventType and active properties of an existing communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to update. requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchCommRequest' required: true responses: '202': description: The communication has been updated successfully. content: application/json: schema: $ref: '#/components/schemas/CommDetail' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to update an existing communication. '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId} responses: default: statusCode: '202' requestParameters: integration.request.path.commId: method.request.path.commId passthroughBehavior: when_no_match connectionType: VPC_LINK get: tags: - Comms APIs operationId: getComm-detail summary: Get Communication description: Get a single communication by its ID. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/CommDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId} connectionType: VPC_LINK /comm/resend: post: tags: - Comms APIs operationId: postResendComm summary: Resend Communication description: Resend a communication. parameters: - in: query name: commId schema: type: string required: true description: The ID of the communication to resend. requestBody: content: application/json: schema: $ref: '#/components/schemas/ResendCommRequest' required: true responses: '201': description: The communication was created successfully. content: application/json: schema: $ref: '#/components/schemas/CommsResponse' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to create a new communication. '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/resend responses: default: statusCode: '201' passthroughBehavior: when_no_match connectionType: VPC_LINK /comm/{commId}/stop: patch: tags: - Comms APIs operationId: patchStopComm summary: Stop Communication description: Stop a communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to stop. responses: '200': description: The communication was stopped successfully. content: application/json: schema: $ref: '#/components/schemas/StopCommsResponse' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to stop a communication. '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: type: http_proxy connectionId: 11ofco httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/stop responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId passthroughBehavior: when_no_match connectionType: VPC_LINK /comm/{commId}/publish-options: patch: tags: - Comms APIs operationId: deactivateComm-publishOptionMessage summary: Deactivate or expire a single communication publish option message description: Deactivate or expire a single communication publish option message parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivatePublishOptionVO' required: true responses: '200': description: The comm publish option message was deactivated successfully. content: application/json: schema: $ref: '#/components/schemas/PublishOptionMessageDeactivatedResponse' '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to deactivate a comms publish option path message. '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: PATCH uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/publish-options connectionType: VPC_LINK get: tags: - Comms APIs operationId: getComm-publishOptions summary: Retrieve a single communication publish option path detail description: Retrieve a single communication publish option path detail. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - in: query name: publishOptionPath required: true schema: type: string enum: - AudioBulletinBoard - WebWidget - MemberPortal - SocialMedia description: Communication publish option path you want to fetch. responses: '200': description: The communication publish option path detail. content: application/json: schema: $ref: '#/components/schemas/PublishOptionPathResponse' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/publish-options connectionType: VPC_LINK /comm/{commId}/confirmation-result: post: tags: - Comms APIs operationId: postComm-confirmationResult summary: Generate a resultset based on communication confirmations description: Generates one or more resultsets, to be used for sending a follow-up communication to recipients who have provided specified responses. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication recipients reacted to. requestBody: content: application/json: schema: type: array description: Confirmations to include in results. items: type: string description: The confirmation to include in results. responses: '200': description: The resultset has been created. content: application/json: schema: type: array items: type: string '400': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '401': description: The token provided does not have permission to generate a result set from the communication. '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/confirmation-result connectionType: VPC_LINK /comm/{commId}/operator-confirmation: post: tags: - Comms APIs operationId: postComm-operatorConfirmation summary: Confirm operators for a communication description: Confirms operator responses for the specified communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication to confirm. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OperatorConfirmationRequest' responses: '200': description: Operator confirmation processed. content: application/json: schema: $ref: '#/components/schemas/OperatorConfirmationResponse' '404': description: Communication not found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications/{commId}/operator-confirmation connectionType: VPC_LINK /{commId}/geometry: get: deprecated: true tags: - Comms APIs operationId: get-communication-geometry summary: Get communication geometry description: Return the geometry of a communication if it exists. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - name: responseType in: query required: false schema: type: string enum: - Default - GeoJSON pattern: ^(?i)(default|geojson)$ description: The type of response to be returned. description: The type of response to be returned. The default is the `inArea` of the combined SemanticQuery by omitting or passing `default`. Alternatively `geojson` can be returned instead to return GeoJSON (RFC 7946). responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/Geometry' examples: Default: summary: Default response value: inArea: true geometry: type: Polygon coordinates: - - - -73.9822 - 40.7681 - - -73.9822 - 40.7681 GeoJSON: summary: GeoJSON response value: type: FeatureCollection features: - type: Feature geometry: type: Polygon coordinates: - - - -122.4194 - 37.7749 - - -122.4066 - 37.7849 - - -122.3995 - 37.7734 - - -122.4114 - 37.7683 - - -122.4194 - 37.7749 properties: {} '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/geometry connectionType: VPC_LINK /{commId}/settings: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidSettings summary: Get Communication Settings description: Get the settings for a communication parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/ApiSettings' examples: Retrieving an ad-hoc communication's settings: summary: Retrieving an ad-hoc communication's settings value: id: null sender: email: name: John Everbridge replyToEmail: jeverbridge@example.com voice: - countryCode: US callerId: +1 888-888-8888 default: true sms: - countryCode: US smsId: 123SMS delivery: paths: - type: Prompt prompt: Work Phone pathOrder: Organization ttl: PT1H deliveryRetries: 3 pathInterval: PT1M deliveryInterval: PT15M applyThrottle: false quietTimeOverride: true recipientInteraction: confirm: true smsCallback: false voiceMailOption: MessageOnly mobileSettings: requestImage: true requestLocation: false allowShare: true requireConfirm: false requestComment: true '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication or settings could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/settings connectionType: VPC_LINK /{commId}/context: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidContext summary: Get Communication Context Data description: Get the contextual data used in rendering a communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/ContextData' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/context connectionType: VPC_LINK /{commId}/content/{contentId}: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidBody summary: Get Communication Body description: Get the content for a specific communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - name: contentId in: path required: true schema: type: string description: The contentBodyId. responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/MessageDetailBody' examples: Retrieving an textual message detail: value: content: title: Test SMS language: en-US contentType: text/plain paths: - CATEGORY:SMS attachments: - fileId: 66ac08c7caa9cf723ac7d30b fileName: Working Arrangements (Employee).pdf mimeType: null downloadUri: https://evbg-dev3-us-west-2-notification-uploads.s3.us-west-2.amazonaws.com/evbg-dev3-us-west-2-notification-uploads_66ac08c7caa9cf723ac7d30b.pdf size: 327140 content: The human torch was denied a bank loan Retrieving an social media message Detail: summary: Retrieving an social media message body value: content: body: The sicail media test body tokenIds: - token1 - token2 image: fileId: 66ac08c7caa9cf723ac7d30a fileName: test.jpg mimeType: null downloadUri: https://evbg-dev3-us-west-2-notification-uploads.s3.us-west-2.amazonaws.com/evbg-dev3-us-west-2-notification-uploads_66ac08c7caa9cf723ac7d30b.pdf size: 327140 customContents: - type: Twitter title: subject body: twitter body image: fileId: 66ac08c7caa9cf723ac7d30a fileName: test.jpg mimeType: null downloadUri: https://evbg-dev3-us-west-2-notification-uploads.s3.us-west-2.amazonaws.com/evbg-dev3-us-west-2-notification-uploads_66ac08c7caa9cf723ac7d30b.pdf size: 327140 webPageMessage:
twitter web page message
- type: Facebook title: title body: msg image: fileId: 66ac08c7caa9cf723ac7d30a fileName: test.jpg mimeType: null downloadUri: https://evbg-dev3-us-west-2-notification-uploads.s3.us-west-2.amazonaws.com/evbg-dev3-us-west-2-notification-uploads_66ac08c7caa9cf723ac7d30b.pdf size: 327140 '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId integration.request.path.contentId: method.request.path.contentId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/content/{contentId} connectionType: VPC_LINK /{commId}/recipients: get: deprecated: true tags: - Comms APIs operationId: getCem-recipeints summary: Get Communication CEM Results description: Return CEM Results id's based on their grouping. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). responses: '200': description: A communication was found matching the given `commId`. content: application/json: examples: Returned CEM Results: value: Group: evbg+result:contact:communications-951c4240-9258-4091-9e32-40e73c1cc881:groups Individual: evbg+result:contact:communications-951c4240-9258-4091-9e32-40e73c1cc881:individuals PublicUser: evbg+result:publicuser:communications-951c4240-9258-4091-9e32-40e73c1cc881:publicUser-0 '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipients connectionType: VPC_LINK /{commId}/recipient-logs: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidrecipientLogs summary: List Communication recipient logs description: List the recipient logs for a specific communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - in: query name: includePublicUser schema: type: boolean description: To include or exclude the public users in the results. Default is false, which excludes public users. - in: query name: status schema: type: array items: type: string enum: - Duplicate - Unreachable - Attempted - ConfirmedLate - Confirmed description: Filter the recipient logs by the current delivery status. - in: query name: name schema: type: string description: Filter the records returned by the name.The 'name' is optional,the records with match all the record that firstName or lastName start with the input value. - in: query name: externalId schema: type: string description: Filter records returned by the externalId.The 'externalId' is optional. - in: query name: recipientSourceType schema: type: string enum: - Individual - Group - Rule - Map - Alert description: Filter record by recipient source type. When provided without an explicit sourceId, this parameter may be translated server-side to an exact sourceId for the communication. When sourceId is present, the recipientSourceType filter is not sent to the backend to avoid redundant filtering. - in: query name: sourceId schema: type: string description: Filter recipients by source identifier. This parameter allows filtering by specific result set identifiers (e.g., 'evbg+result:contact:communications-abc123:groups'). When used with sourceIdWildcard=true, supports pattern matching. When sourceId is present, the recipientSourceType filter is not sent to the backend to avoid redundant filtering. External clients should URL-encode sourceId values that contain reserved characters such as '+', ':', or '*'. - in: query name: sourceIdWildcard schema: type: boolean description: Enable wildcard matching for the sourceId parameter. When true, the sourceId is treated as a pattern for matching (e.g., '*:*:*:groups*' matches any result set ending with ':groups'). - in: query name: confirmedPathCategory schema: type: string enum: - SMS - EMAIL - VOICE - MOBILEAPP - PLAINTEXT - BUSINESSMESSAGINGAPPS description: 'Filter records by confirmedPathCategory.If ''confirmedPathCategory'' is not specified ,then the record set will include all kinds of confirmedPathCategory ' - in: query name: pollResponse schema: type: string description: Filters by the poll response content,the 'pollResponse' is optional - in: query name: pageSize schema: type: integer format: int32 description: The size of each page of search results. Defaults to ten records. - in: query name: pageNumber schema: type: integer format: int32 description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 0. responses: '200': description: A communication was found matching the given `commId`. content: application/json: schema: $ref: '#/components/schemas/CommRecipientLog' examples: Retrieving Recipient Log: summary: Example of recipient Log value: - recipientId: '443139156345652' contactLogId: 69727dbcef529a4d482b578e fullName: ethan an externalId: ethanantest recipientSources: type: Individual status: Attempted firstAttemptDate: '2024-07-05T01:32:09.811Z' latestAttemptDate: '2024-07-05T01:32:10.027Z' confirmDate: null confirmedPathId: null confirmedPathCategory: SMS confirmedPathName: null confirmedPathValue: null pollResponse: null recipientLogByPath: - pathCategory: SMS pathId: '443139156345651' pathName: Personal Email 1 pathValue: ethan.an@everbridge.com status: Attempted attemptTime: '2024-07-05T01:32:10.027Z' callResult: Sent - pathCategory: EMAIL pathId: '443139156345652' pathName: Microsoft Teams pathValue: ethan.an@6qbch6.onmicrosoft.com status: Attempted attemptTime: '2024-07-05T01:32:09.811Z' callResult: Not Delivered - Invalid Path '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipient-logs connectionType: VPC_LINK /{commId}/recipient-logs/download: post: deprecated: true tags: - Comms APIs operationId: postCem-commsCommidRecipientLogsDownload summary: Create Communication recipient log download description: Create a CSV recipient log export for a specific communication. Synchronous exports return a download URI in the response body. Asynchronous exports return a task ID. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - in: query name: exportType required: false schema: type: string default: per-confirmation enum: - per-confirmation - per-path - per-recipient description: Controls how recipient log rows are grouped in the CSV export. Defaults to `per-confirmation`. responses: '200': description: A synchronous export completed and includes a download URI. content: application/json: schema: $ref: '#/components/schemas/RecipientLogDownloadResponse' examples: Synchronous recipient log export: value: mode: SYNC downloadUri: https://example.com/recipient-log.csv '202': description: An asynchronous export task was created and queued. content: application/json: schema: $ref: '#/components/schemas/RecipientLogDownloadResponse' examples: Asynchronous recipient log export: value: mode: ASYNC taskId: task-123 '400': description: The `commId` or `exportType` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication or its notification could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: '202': statusCode: '202' default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipient-logs/download connectionType: VPC_LINK /{commId}/summary/{summaryType}: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidSummary summary: Get Communication Summary by Summary Type description: Get the summary by summary type parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - name: summaryType in: path required: true schema: type: string enum: - confirmation-status - recipient-statistics - recipient-statistics-resend - recipient-statistics-thread - recipient-statistics-root - confirmation-by-path - poll-response - public-incident-zone description: The summaryType. responses: '200': description: A communication summary was found matching the given `commId` and 'summaryType'. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConfirmationSummary' - $ref: '#/components/schemas/recipientStatisticSummary' - $ref: '#/components/schemas/ConfirmationByPathSummary' examples: Retrieving an confirmationStatus's summary: summary: Retrieving an confirmationStatus's summary value: totalCount: 10 totalPublicCount: 0 confirmedCount: 5 pendingConfirmedCount: 2 unreachableCount: 1 confirmedLateCount: 4 '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId integration.request.path.summaryType: method.request.path.summaryType type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/summary/{summaryType} connectionType: VPC_LINK /{commId}/activities: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidActivities summary: List Communication Activities description: List the activities for a specific root communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication as returned by [Launch Communication](https://developers.everbridge.net/internal/reference/postcem-comms). - name: pageNumber in: query schema: type: integer format: int32 minimum: 1 description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 1. - name: pageSize in: query schema: type: integer format: int32 minimum: 1 maximum: 100 description: The size of each page of search results. Defaults to ten records. responses: '200': description: A paginated response of the activities for the communication. content: application/json: schema: $ref: '#/components/schemas/ActivityPaginatedResponse' examples: Retrieving an activity entry: summary: Retrieving an activity entry value: data: - actor: 2ec35f14-6ffe-4afb-880a-2bde3fc57a6a target: null createdBy: id: '2379963248410625' username: jane.doe firstName: Jane lastName: Doe fullName: Jane Doe createdAt: '2024-11-04T19:31:20.050759Z' actionType: INIT messageType: STANDARD updates: - actor: 8aa02525-2993-4f64-b6db-493fa5e689a7 target: 2ec35f14-6ffe-4afb-880a-2bde3fc57a6a createdBy: id: '2389927572537388' username: john.doe firstName: John lastName: Does fullName: John Doe createdAt: '2024-11-04T21:03:55.256114Z' actionType: UPDATE messageType: STANDARD updates: null pages: currentPage: 1 pageSize: 10 pageCount: 1 totalPages: 1 maxSize: 100 totalCount: 1 security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/activities connectionType: VPC_LINK /{commId}/activity-entry: get: deprecated: true tags: - Comms APIs operationId: getCem-commsCommidActivityEntry summary: Retrieve a single communication activity entry description: Retrieve a single communication activity entry for any communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication for which to retrieve the associated activity entry. responses: '200': description: The communication activity entry. content: application/json: schema: $ref: '#/components/schemas/ActivityEntry' examples: Retrieving an activity entry: summary: Retrieving an activity entry value: actor: 40ad7521-6820-4795-9c7c-cd0d6a9dd99b target: ebd15980-4183-4fb7-a037-bc4f1e42b990 createdBy: id: '2389927572537369' username: SummerVCC firstName: summer lastName: dong fullName: summer dong createdAt: '2024-10-17T01:17:39.558055Z' actionType: UPDATE messageType: STANDARD updates: null security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/activity-entry connectionType: VPC_LINK /{commId}/thread-recipients: get: deprecated: true tags: - Comms APIs operationId: getCem-threadRecipients summary: Retrieve a thread's CEM Results description: Retrieve an object containing the CEM Results id's for a specific communication thread. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication for which to retrieve the publish option path detail. - name: threadSearchOrder in: query required: false schema: type: string enum: - descendantAsRoot - ancestor - descendant description: The search order to find the thread's root communication. Default is 'descendantAsRoot', which means searching from the current communication to its descendants to find the root communication. 'ancestor' means searching from the current communication to its ancestors to find the root communication. 'descendant' is like DescendantAsRoot but without FOLLOWUP ones. responses: '200': description: The communication publish option path detail info. content: application/json: schema: $ref: '#/components/schemas/ThreadRecipientsResponse' examples: Retrieving communication thread CEM Results: summary: Retrieving communication thread CEM Results value: - commId: f8114245-b70b-4907-9c87-87a9ebd5d38b resultsets: Group: evbg+result:contact:communications-f8114245-b70b-4907-9c87-87a9ebd5d38b:groups - commId: f61477b3-60cf-4c49-a113-594f64b4fe37 resultsets: Individual: evbg+result:contact:communications-f61477b3-60cf-4c49-a113-594f64b4fe37:individuals-0 - commId: 2308da29-37ae-4f31-8338-85b8558e5797 resultsets: Individual: evbg+result:contact:communications-2308da29-37ae-4f31-8338-85b8558e5797:individuals-0 - commId: c8fcdb92-d320-496e-af46-2c1763ffd1d5 resultsets: Group: evbg+result:contact:communications-c8fcdb92-d320-496e-af46-2c1763ffd1d5:groups Individual: evbg+result:contact:communications-c8fcdb92-d320-496e-af46-2c1763ffd1d5:individuals-0 - commId: 3f2893a8-e88a-4ac9-bdea-55a1f25fc717 resultsets: Exclusion: evbg+result:contact:communications-3f2893a8-e88a-4ac9-bdea-55a1f25fc717:excludedIndividuals-0 Individual: evbg+result:contact:communications-3f2893a8-e88a-4ac9-bdea-55a1f25fc717:individuals-0 '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/thread-recipients connectionType: VPC_LINK /comm/{commId}/geometry: get: tags: - Comms APIs operationId: getComm-geometry summary: Get communication geometry description: Return the geometry of a communication if it exists. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - name: responseType in: query required: false schema: type: string enum: - Default - GeoJSON description: The type of response to be returned. responses: '200': description: Geometry for the communication. content: application/json: schema: $ref: '#/components/schemas/Geometry' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/geometry connectionType: VPC_LINK /comm/{commId}/settings: get: tags: - Comms APIs operationId: getComm-settings summary: Get Communication Settings description: Get the settings for a communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. responses: '200': description: Settings for the communication. content: application/json: schema: $ref: '#/components/schemas/ApiSettings' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication or settings could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/settings connectionType: VPC_LINK /comm/{commId}/context: get: tags: - Comms APIs operationId: getComm-context summary: Get Communication Context Data description: Get the contextual data used in rendering a communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. responses: '200': description: Context data for the communication. content: application/json: schema: $ref: '#/components/schemas/ContextData' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/context connectionType: VPC_LINK /comm/{commId}/content/{contentId}: get: tags: - Comms APIs operationId: getComm-content summary: Get Communication Body description: Get the content for a specific communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - name: contentId in: path required: true schema: type: string description: The contentBodyId. responses: '200': description: Content for the communication. content: application/json: schema: $ref: '#/components/schemas/MessageDetailBody' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId integration.request.path.contentId: method.request.path.contentId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/content/{contentId} connectionType: VPC_LINK /comm/{commId}/recipients: get: tags: - Comms APIs operationId: getComm-recipients summary: Get Communication CEM Results description: Return CEM Results id's based on their grouping. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. responses: '200': description: CEM Results for the communication. '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipients connectionType: VPC_LINK /comm/{commId}/recipient-logs: get: tags: - Comms APIs operationId: getComm-recipientLogs summary: List Communication recipient logs description: List the recipient logs for a specific communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - in: query name: includePublicUser schema: type: boolean description: To include or exclude the public users in the results. - in: query name: status schema: type: array items: type: string enum: - Duplicate - Unreachable - Attempted - ConfirmedLate - Confirmed description: Filter the recipient logs by the current delivery status. - in: query name: name schema: type: string description: Filter the records returned by the name. - in: query name: externalId schema: type: string description: Filter records returned by the externalId. - in: query name: recipientSourceType schema: type: string enum: - Individual - Group - Rule - Map - Alert description: Filter record by recipient source type. When provided without an explicit sourceId, this parameter may be translated server-side to an exact sourceId for the communication. - in: query name: confirmedPathCategory schema: type: string enum: - SMS - EMAIL - VOICE - MOBILEAPP - PLAINTEXT - BUSINESSMESSAGINGAPPS description: Filter records by confirmedPathCategory. - in: query name: pollResponse schema: type: string description: Filters by the poll response content. - in: query name: pageSize schema: type: integer format: int32 description: The size of each page of search results. - in: query name: pageNumber schema: type: integer format: int32 description: The requested page number. responses: '200': description: Recipient logs for the communication. content: application/json: schema: $ref: '#/components/schemas/CommRecipientLog' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipient-logs connectionType: VPC_LINK /comm/{commId}/recipient-logs/download: post: tags: - Comms APIs operationId: postComm-recipientLogsDownload summary: Create Communication recipient log download description: Create a CSV recipient log export for a specific communication. Synchronous exports return a download URI. Asynchronous exports return a task ID. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - in: query name: exportType required: false schema: type: string default: per-confirmation enum: - per-confirmation - per-path - per-recipient description: Controls how recipient log rows are grouped in the CSV export. Defaults to `per-confirmation`. responses: '200': description: A synchronous export completed and includes a download URI. content: application/json: schema: $ref: '#/components/schemas/RecipientLogDownloadResponse' '202': description: An asynchronous export task was created and queued. content: application/json: schema: $ref: '#/components/schemas/RecipientLogDownloadResponse' '400': description: The `commId` or `exportType` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication or its notification could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: '202': statusCode: '202' default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: POST uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/recipient-logs/download connectionType: VPC_LINK /comm/{commId}/summary/{summaryType}: get: tags: - Comms APIs operationId: getComm-summary summary: Get Communication Summary by Summary Type description: Get the summary by summary type. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - name: summaryType in: path required: true schema: type: string enum: - confirmation-status - recipient-statistics - recipient-statistics-resend - recipient-statistics-thread - recipient-statistics-root - confirmation-by-path - poll-response - public-incident-zone description: The summaryType. responses: '200': description: Summary for the communication. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConfirmationSummary' - $ref: '#/components/schemas/recipientStatisticSummary' - $ref: '#/components/schemas/ConfirmationByPathSummary' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId integration.request.path.summaryType: method.request.path.summaryType type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/summary/{summaryType} connectionType: VPC_LINK /comm/{commId}/activities: get: tags: - Comms APIs operationId: getComm-activities summary: List Communication Activities description: List the activities for a specific root communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - name: pageNumber in: query schema: type: integer format: int32 minimum: 1 description: The requested page number. - name: pageSize in: query schema: type: integer format: int32 minimum: 1 maximum: 100 description: The size of each page of search results. responses: '200': description: A paginated response of the activities for the communication. content: application/json: schema: $ref: '#/components/schemas/ActivityPaginatedResponse' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/activities connectionType: VPC_LINK /comm/{commId}/activity-entry: get: tags: - Comms APIs operationId: getComm-activityEntry summary: Retrieve a single communication activity entry description: Retrieve a single communication activity entry for any communication. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. responses: '200': description: The communication activity entry. content: application/json: schema: $ref: '#/components/schemas/ActivityEntry' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/activity-entry connectionType: VPC_LINK /comm/{commId}/thread-recipients: get: tags: - Comms APIs operationId: getComm-threadRecipients summary: Retrieve a thread's CEM Results description: Retrieve an object containing the CEM Results id's for a specific communication thread. parameters: - name: commId in: path required: true schema: type: string description: The ID of the communication. - name: threadSearchOrder in: query required: false schema: type: string enum: - descendantAsRoot - ancestor - descendant description: The search order to find the thread's root communication. responses: '200': description: The thread's CEM Results. content: application/json: schema: $ref: '#/components/schemas/ThreadRecipientsResponse' '400': description: The `commId` provided was not in the correct format. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '404': description: The communication could not be found. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' '500': description: An internal error has occurred. content: application/json: schema: $ref: '#/components/schemas/ProblemDetail' security: - API_Authorizer: [] x-amazon-apigateway-integration: passthroughBehavior: when_no_match connectionId: 11ofco responses: default: statusCode: '200' requestParameters: integration.request.path.commId: method.request.path.commId type: http_proxy httpMethod: GET uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/communications-query/{commId}/thread-recipients connectionType: VPC_LINK components: schemas: ContentMetadata: type: object properties: contentType: type: string description: An [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646) standard language code describes what language the `content` is authored in. Please refer to [the Wikipedia page on IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags) for a list of common subtags. example: text/plain language: $ref: '#/components/schemas/SupportedLanguages' description: The language of the content, as defined by the IETF's RFC 5646. example: en-US category: type: string description: A value used to categorize the content. example: text pathTypes: type: array items: type: string example: sms description: The deliveryPaths to which the content was targeted. contentLink: type: string format: uri description: The link to the content. example: https://api.everbridge.net/managerapps/communications/v1/a5a71f87-4f3b-472f-a39d-47cc1c3c9b30/contents/text/en-US AudioBulletinBoardPublicMessage: type: object description: The ABB public message content. required: - title - body - settingId properties: title: type: string description: The title of abb. body: type: string description: The core content of abb. settingId: type: string description: The setting id of abb that defined in setting page. audioKey: type: string description: 'The system-generated audio Key referring to the audio file for this message. ' expires: type: string description: How long the message expires. This is in formatted in the ISO 8601 "duration" format. example: PT5H ActivityEntry: type: object properties: actor: description: The ID of the communication for this activity. type: string example: 3617cd9d-1815-4e35-9bfe-2a8def879956 target: description: The ID of the target communication for this activity. type: string example: ebd15980-4183-4fb7-a037-bc4f1e42b990 root: description: The ID of the thread root communication. type: string example: 380778f9-5cde-404f-8d28-c1b1526c9f57 createdBy: $ref: '#/components/schemas/UserReference' createdAt: description: ISO 8601-compliant value for when the communication is created type: string example: '2024-10-17T01:51:39.721617Z' actionType: description: The activity log action type. type: string enum: - INIT - FOLLOWUP - UPDATE - RESEND - CLOSE - REOPEN messageType: description: 'The activity log message type ' type: string enum: - STANDARD - POLL - CONFERENCE CommRecipientLogPerPath: type: object properties: pathCategory: type: string description: The path category of the recipient Log. awareId: type: string description: The PathId of the recipient Log. pathName: type: string description: The PathName of the recipient Log. pathValue: type: string description: The value of the current path. The value can be a email address or a phone number. status: type: string description: The status of the current path enum: - Duplicate - Unreachable - Attempted - ConfirmedLate - Confirmed attemptTime: description: Time the current path attempt to delivery. type: string format: date-time callResult: type: string description: The call result of the recipient Log. enum: - Voice Confirmed - Fax Not Confirmed - Recipient cannot be reached - Sent - Sent - Standard SMS - Sent (via RCS) - Sent - Attachments not Included - Delivered - Delivered - To Voicemail - Not Delivered - Voicemail Setting is Off - Not Delivered - Incorrect Security Code - Not Delivered - Duplicate Contact - Not Delivered - Duplicate Path - Not Delivered - Contact Path Not Defined - Not Delivered - Notification Expired - Confirmed - Confirmed (via RCS) - Confirmed by Operator - Confirmed by Call Back - Confirmed - On Conference Call - Confirmed - Conference Call Ended - Confirmed - Declined to Join Conference Call - Not Delivered - Voicemail Hung Up - Not Delivered - Recipient Hung Up - Not Delivered - No Answer - Not Delivered - Invalid Number - Not Delivered - Line Busy - Not Delivered - Communication Error - Not Delivered - Everbridge System Error - Not Delivered - Blocked Phone Number - 'Not Delivered - Device Not Detected ' - Not Delivered - Out of Service - Not Delivered - Voicemail Detected - Not Delivered - No Fax Machine - Not Delivered - Server Error - Not Delivered - Recipient Mailbox is Full - Not Delivered - Invalid Email Address - Not Delivered - No Associated Device - Not Delivered - Unregistered Device - Not Delivered - No Push Service - Not Delivered - Carrier Rejected - Not Attempted - Unsubscribed - Not Attempted - Bounced Email - Not Attempted - Inactive Path - Not Attempted - Invalid Path - Not Attempted - Email Preferred over SMS - Not Attempted - Throttling Time Exceeded - Not Delivered - Downstream Communication Error - Not Delivered - Carrier Expired - Delivered - To Carrier - Delivered - To Handset - Delivered - To Handset (via RCS) - Not Delivered - Bounced Email - Not Delivered - Rendering Failure - Not Delivered - Reject - Not Delivered - Other Reason - Not Delivered - Device not enable RCS - Not Delivered - Invalid Path - Read Facebook: type: object description: The Facebook custom message content. properties: body: type: string description: The core content sent to facebook. imageId: type: string description: The system-generated image ID referring to the image file that will be sent to facebook image: $ref: '#/components/schemas/ContentAttachment' LaunchMessageBody: type: object required: - contentType - title properties: contentType: type: string description: "A MIME type, defined in IETF's [RFC 6838](https://datatracker.ietf.org/doc/html/rfc6838), that describes the content type (e.g. `text/plain` for plain text or `audio/ogg` for an audio file). The content types that are valid for a given message body depends on the `type` of the message body:\n * `AudioMessageBody`: Supports only `audio` MIME types with any of its supported contact delivery path types.\n * `TextualMessageBody`: Supports only `text` MIME types with any of its supported contact delivery path types; for audio-only contact delivery path types, the text content will be translated to spoken audio via text-to-speech.\n * `WebPageMessageBody`: Supports only `text` MIME types with any of its supported contact delivery path types." title: type: string description: A title for the notification. For audio messages, this is used for display purposes within the Everbridge portal. minLength: 1 maxLength: 255 PathCategory: type: string enum: - CATEGORY:BUSINESSMESSAGINGAPPS - CATEGORY:COMMON - CATEGORY:EMAIL - CATEGORY:MOBILEAPP - CATEGORY:PLAINTEXT - CATEGORY:SMS - CATEGORY:VOICE recipientStatisticSummary: description: Recipient statistics summary associated with the communication. - STILL IN DEVELOPMENT type: object properties: total: description: Total count of selected recipients type: integer example: '16' individual: description: Count of recipient selected from individual type: integer example: '8' groups: description: Count of recipients selected from groups type: integer example: '3' rules: description: Count of recipient selected from rules type: integer example: '4' maps: description: Count of recipient selected from maps type: integer example: '1' excluded: description: Count of recipient selected out type: integer example: '0' subscriptions: description: Count of recipient selected from subscriptions or public users type: integer example: '0' alert: description: Count of recipient selected from alerts type: integer example: '0' PublishOptionPathResponse: type: object description: The publish option path detail info you requested. properties: path: type: string description: the publish option path you are fetching. name: type: string description: The name of the web widget publish option path. status: type: string description: The status of web widget publish option path message. enum: - Active - Expired - Failed - Deactivated - InProgress durationType: type: string description: duration type enum: - SameAsBroadcastDuration - SetByCalendar - Custom expirationDate: type: string description: The date when the web widget message will expired deactivatedBy: type: string description: The user who deactivate the web widget message example: Ranen Liu deactivatedDate: type: string description: The date when the web widget message was deactivated expireDateTime: type: string description: The date time when abb message expired futureExpireDateTime: type: string description: The date time when abb message will expire twitter: type: array description: The title of social media. items: type: object properties: twitterName: description: The twitter account configured to receive publish message in social media type: string status: description: The status of message was sent to twitter example: Failed type: string errorMessage: description: The error of twitter message failed type: string errorCode: description: The error code of twitter message failed type: integer facebook: type: array description: The facebook account configured to receive publish message in social media items: type: string StopCommsResponse: required: - id type: object properties: id: type: string description: The ID of the communication that was stopped. CommRecipientSource: type: object properties: type: type: string description: The way that recipient is selected from. enum: - Individual - Group - ContactFilter - Area names: type: string description: The specific names of the type,group name or contact filter names. DeliverySettings: type: object description: Settings that adjust the way that notifications are delivered to recipients. properties: paths: type: array description: A list of contact delivery paths to use in notifying recipients. Refer to the [Everbridge List Contact Paths API](https://developers.everbridge.net/internal/reference/ebs-list-contact-paths) to find contact delivery paths for an organization. items: $ref: '#/components/schemas/ApiDeliveryPath' pathOrder: type: string description: Determines which ordering of delivery paths are used for this notification. enum: - CONTACT - ORGANIZATION - CUSTOM ttl: type: string description: "The amount of time, beginning at the communication's launch, to continue sending notifications (\"time-to-live\"). This is in formatted in the ISO 8601 \"duration\" format and must be specified as a number of whole hours.\n Supports a minimum value of one minute up to a maximum value of five days." example: PT5H deliveryRetries: type: integer description: The number of attempts to contact recipients that haven't responded. maximum: 20 pathInterval: type: string description: How long the system should wait before attempting to contact the next device in a recipient's delivery paths. This is in formatted in the ISO 8601 "duration" format. enum: - PT0M - PT1M - PT2M - PT3M - PT5M - PT10M - PT15M deliveryInterval: type: string description: "How long the system should wait before attempting another delivery starting from the beginning of a recipient's delivery paths.\n Supported values are 0 minutes, 1 minute, 2 minutes, or multiples of 5 minutes up to 60 minutes." example: PT15M applyThrottle: type: boolean description: If set to true, will throttle the number of phone calls made. quietTimeOverride: type: boolean description: If set to true, then notifications from this communication will ignore recipients' quiet time settings (i.e. phone calls will be made despite the recipient opting to only receive them during a certain time range.) ContactRecipientExternalId: type: object description: Refers to a contact recipient by its contact external ID. required: - type - externalId properties: type: type: string description: Must be set to exactly `ExternalId`. enum: - ExternalId externalId: type: string description: The organization-provided contact external ID from the [Everbridge Contacts API](https://developers.everbridge.net/internal/reference/ebs-list-contacts). CommData: type: object properties: organizationId: type: string description: The Everbridge organization ID that owns the communication. commId: type: string description: The ID of the communication. status: type: string enum: - CANCELLED - FAILED - PROCESSING - READY - SCHEDULED - SENT description: "The current status of the communication:\n * `CANCELLED`: The communication was stopped before it could complete its entire lifecycle.\n * `FAILED`: The communication failed to send.\n * `PROCESSING`: The communication is currently being compiled and has not yet been sent.\n * `READY`: The communication has been compiled but has not yet been sent.\n * `SENT`: The communication has been sent and will begin notifying shortly." title: type: string description: The title of the communication. mode: type: string enum: - Live - Simulation - Preview description: "Describes the behavior of the communication:\n * `Live`: Launch the communication and send notifications to all recipients.\n * `Simulation`: Launch the communication but do not send notifications; useful for determining the impact of a communication before sending it with `Live`.\n * `Preview`: Render the template and its fields for preview but does not launch the communication nor send any notifications." tags: type: array items: $ref: '#/components/schemas/Tag' description: A list of tags assigned to the communication. notifications: type: array items: type: object properties: notificationId: type: string description: The ID of the notification. status: type: string enum: - CANCELLED - FAILED - PROCESSING - READY - SENT description: "The current status of the notification:\n * `CANCELLED`: The notification was stopped before it could complete its entire lifecycle.\n * `FAILED`: The notification failed to send.\n * `PROCESSING`: The notification is currently being compiled and has not yet been sent.\n * `READY`: The notification has been compiled but has not yet been sent.\n * `SENT`: The notification has been sent and will begin notifying shortly." priority: description: Priority of the communication example: NORMAL type: string enum: - NORMAL - HIGHPRIORITY - LIFETHREATENING name: description: Name of the communication. example: Test Communication type: string eventType: description: Type of event example: TODO type: string launchedBy: type: string description: The full name of the user who launched this communication publicSafety: type: boolean description: Communication is being sent as a Public Safety message launchedFrom: type: string description: The source of the communication launch. This is used for tracking purposes and does not affect the behavior of the communication. Public should use API. enum: - API - UI - ORCHESTRATION - CRITICALEVENT - SAFETYMESSAGE - COMMSSCHEDULE - RESPONSEMGMT sent: description: Time the communication was sent. example: Test Communication type: string format: date-time confirmationStatus: $ref: '#/components/schemas/ConfirmationSummary' threadStatus: description: Communication thread is active or inactive example: INACTIVE type: string enum: - ACTIVE - INACTIVE planId: type: string description: The ID of the plan that launched the with communication, if any. PreviewCommResponse: type: object description: The rendered communication content for preview. properties: contents: type: object description: The rendered communication content, keyed by locale. additionalProperties: $ref: '#/components/schemas/MessageContent' SupportedLanguages: type: string description: "A combined language and region tag that signifies the default language to use when selecting a message body to send to a recipient.\n *Note:* Currently, all communication message bodies in a single communication are signified as being spoken or written in the language defined in this property." default: en_US enum: - ar_SA - bn_BD - cy_GB - da_DK - de_DE - el_GR - en_GB - en_US - es_ES - es_US - fi_FI - fr_FR - he_IL - ht_HT - id_ID - it_IT - ja_JP - ko_KR - nl_NL - no_NO - pl_PL - pt_BR - pt_PT - ru_RU - sv_SE - th_TH - tr_TR - uk_UA - ur_PK - vi_VN - yi_US - zh_CN VoiceSettings: type: object description: The caller ID number displayed when contacting recipients via phone. required: - countryCode - callerId - default properties: countryCode: type: string description: The ISO 3166 two-letter code for the country where this phone number is valid. Please refer to [the Wikipedia page on ISO 3166 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) for valid values. callerId: type: string description: The caller ID phone number in E. 164 format. default: type: boolean description: If true, then this is the caller ID number used when no other applies. ApiDeliveryPathPathId: type: object description: A unique identifier for the delivery path. required: - type - pathId properties: type: type: string description: Must be set to exactly `PathId`. enum: - PathId pathId: type: string description: The path ID itself. ConfirmationSummary: description: A list of summaries associated with the communication. - STILL IN DEVELOPMENT type: object properties: totalCount: description: Total count of notifications sent type: integer example: '8' totalPublicCount: description: Total count of public users sent type: integer example: '3' confirmedCount: description: Count of confirmations received type: integer example: '3' pendingConfirmedCount: description: Count of confirmations pending type: integer example: '4' unreachableCount: description: Count of unreachable contacts type: integer example: '1' confirmedLateCount: description: Confirmations received after the expiration time type: integer example: '0' ContactRecipientName: type: object description: Refers to a contact recipient by their name as shown in the [Everbridge Contacts API](https://developers.everbridge.net/internal/reference/ebs-list-contacts). required: - type - firstName - lastName properties: type: type: string description: Must be set to exactly `Name`. enum: - Name firstName: type: string description: The contact's first or given name. middleInitial: type: string description: The contact's middle initial. lastName: type: string description: The contact's last name or surname. suffix: type: string description: A suffix to the contact's name. example: Jr. SocialMediaPublicMessage: type: object description: The social media public message content. required: - tokenIds - incLink properties: body: type: string description: The title of social media. tokenIds: type: array description: The tokens of social media ,it can contain the token of both twitter and facebook. items: type: string incLink: type: boolean description: Whether the message publish to social media contains a link imageId: type: string description: The system-generated image ID referring to the image file for this message.. customContents: type: array description: The bodies of the custom social media Each type at most has one item. items: anyOf: - $ref: '#/components/schemas/Facebook' - $ref: '#/components/schemas/Twitter' MessageBody: type: object description: This is the base object that AudioBody, TextualBody, and WebpageBody is build upon. properties: title: type: string description: The title of the notification; may be included in the notification. language: $ref: '#/components/schemas/SupportedLanguages' contentType: type: string example: text/plain description: The MIME type of describing the format of the message body. paths: type: array description: PathCategory instances describing which delivery paths should receive this message body. items: $ref: '#/components/schemas/PathCategory' attachments: type: array description: Attachments to send along with the message body; conditionally required. items: $ref: '#/components/schemas/ContentAttachment' required: - type - title - language - contentType - paths GenericOneWayPublicMessage: type: object description: The GenericOneWay public message content. required: - title - body - receiveUrls properties: title: type: string description: The title of generic one way. body: type: string description: The core content of generic one way. receiveUrls: type: string description: The receive url list of generic one way. items: type: string PublicCommError: properties: when: type: string description: ISO 8601 formatted date-time string of when the error was recorded description: type: array items: type: string description: A list of error messages resulting in the recorded error requestId: type: string description: The provided or assigned request ID for the communication CemResultsCompleteName: type: object description: Used to describe a contact's complete name in a CEM Results query. required: - type - first - last properties: type: type: string description: Must be set to exactly `Complete`. enum: - Complete first: type: string description: The first name of the contact. last: type: string description: The last name of the contact. middleInitial: type: string description: The middle initial of the contact. suffix: type: string description: The suffix of the contact's name, such as "Jr." or "III". CommContentMetadata: type: object properties: paths: type: array items: type: string example: SMS description: The deliveryPaths to which the content was targeted. contentLink: type: string format: uri description: The link to the content. example: https://api.everbridge.net/managerapps/communications/v1/a5a71f87-4f3b-472f-a39d-47cc1c3c9b30/body/{path}] attachments: type: array description: A list of attachments. items: $ref: '#/components/schemas/ContentAttachment' EverbridgeCommunityPublicMessage: type: object description: The Everbridge Community publish toggle. This message carries no body fields and is used only to signal routing/selection in the launch request. MemberPortalBody: type: object description: The member portal public message content. required: - body - includeSelectedMapShape properties: body: type: string description: The core content that displayed on public member public message page. includeSelectedMapShape: type: boolean description: 'Whether include the map defined in recipient part ' ActivityPaginatedResponse: allOf: - $ref: '#/components/schemas/AbstractApiPaginatedResponse' - type: object properties: data: type: array items: $ref: '#/components/schemas/ActivityEntry' required: - data MessageContent: required: - contents type: object description: Notification message content that is included within the communication. If a `templateId` is present, this value becomes optional and will override the template's message content if provided. properties: conferenceBridgeId: type: string description: The ID of a conference bridge for recipients to join. Retrieve conference bridge IDs from the [Everbridge List Conference Bridges API](https://developers.everbridge.net/internal/reference/ebs-list-conference-bridges). Note that this property is mutually exclusive with `questionnaire`; both may not be set in the same communication. questionnaire: type: object description: A list of answers to a provided question for recipients to respond with during confirmation. Note that this property is mutually exclusive with `conferenceBridgeId`; both may not be set in the same communication. required: - answers properties: answers: type: array items: type: object required: - name properties: name: type: string description: The user-friendly text of the questionnaire answer. responseQuota: type: integer description: Defines a minimum number of recipients that must respond with this questionnaire answer. questionText: type: string description: The text prompt to display to recipients when they are responding to the questionnaire. contents: type: array description: The bodies of the notification message shown to recipients. There may be multiple `Textual` message bodies but at most one `Audio` message body and/or at most one `WebPage` message body. items: anyOf: - $ref: '#/components/schemas/AudioMessageBody' - $ref: '#/components/schemas/TextualMessageBody' - $ref: '#/components/schemas/WebPageMessageBody' CommPaginatedResponse: allOf: - $ref: '#/components/schemas/AbstractApiPaginatedResponse' - type: object properties: data: type: array items: $ref: '#/components/schemas/CommData' required: - data DeactivatePublishOptionVO: type: object required: - path - status properties: path: description: The message of which publish option path will be deactivated type: string example: AudioBulletinBoard enum: - AudioBulletinBoard - WebWidget - MemberPortal - SocialMedia status: description: The status of the publish option path message will be change to type: string enum: - Active - Deactivate Tag: type: string description: A value used to contain a simple categorization. example: eventType:hurricane activity: type: object properties: action: type: string enum: - FOLLOWUP - UPDATE - CLOSE description: Specify the type of activity. For example, use this to send an update or follow-up communication, or to close the target communication. target: type: string description: Launches a new communication as a follow-up to an existing communication. The target communication ID to which this communication is related. PreviewCommRequest: description: Request body for previewing a communication. Only valid when `mode` is `PREVIEW`. allOf: - $ref: '#/components/schemas/BaseLaunchCommRequest' - type: object required: - mode properties: mode: $ref: '#/components/schemas/PreviewMode' recipients: type: object description: Metadata for the recipients who would receive the communication if the previewed communication were launched. properties: languages: type: array description: A list of languages preferred by the intended recipients of the communication. The Preview API returns translated message content only for languages that are present in both this list and the configured AI translation settings. items: $ref: '#/components/schemas/SupportedLanguages' PreviewMode: type: string enum: - PREVIEW description: Render the template and its fields for preview but does not launch the communication nor send any notifications. LaunchCommRequest: description: Request body for launching a communication. Only valid when `mode` is `LIVE` or `SIMULATION`. allOf: - $ref: '#/components/schemas/BaseLaunchCommRequest' - type: object required: - title - mode properties: mode: $ref: '#/components/schemas/LaunchMode' title: type: string description: The title or summary of the communication, shown in the Communications interface. This is not the title used in the notification. description: type: string description: A description of the communication. This is not shown to recipients. maxLength: 500 publicSafety: type: boolean description: Communication is being sent as a Public Safety message priority: type: string description: "The level of urgency for this communication.\n * `NORMAL`: The baseline level of urgency.\n * `HIGHPRIORITY`: Action is recommended.\n * `LIFETHREATENING`: Immediate action is required due to the risk of loss of life or bodily harm." enum: - NORMAL - HIGHPRIORITY - LIFETHREATENING eventType: type: string description: A category for the communication. launchedFrom: type: string description: The source of the communication launch. This is used for tracking purposes and does not affect the behavior of the communication. Public should use API. enum: - API - UI - ORCHESTRATION - CRITICALEVENT - SAFETYMESSAGE - COMMSSCHEDULE - RESPONSEMGMT recipients: $ref: '#/components/schemas/LaunchRecipients' publicMessages: type: array description: The bodies of the public message. Each type at most has one body. items: anyOf: - $ref: '#/components/schemas/WebWidgetPublicMessage' - $ref: '#/components/schemas/AlertUsPublicMessage' - $ref: '#/components/schemas/GenericOneWayPublicMessage' - $ref: '#/components/schemas/AudioBulletinBoardPublicMessage' - $ref: '#/components/schemas/SocialMediaPublicMessage' - $ref: '#/components/schemas/MemberPortalPublicMessage' - $ref: '#/components/schemas/EverbridgeCommunityPublicMessage' - $ref: '#/components/schemas/NetworkPublicMessage' - $ref: '#/components/schemas/CAPPublicMessage' activity: $ref: '#/components/schemas/activity' planId: type: string description: Unique identifier of the plan responsible for launching the communication. BaseLaunchCommRequest: type: object properties: templateId: type: string description: 'An ID of a template to use for this communication. Supported template types: - Communication Template: IDs of the form `commsTemplate://{id}` - Notification Template (legacy): IDs of the form `legacyMN://{id}` - Incident Template (legacy): IDs of the form `legacyIC://{id}/{phaseName}` For legacy templates, you can retrieve template details via the `/templates/convert` API.' example: commsTemplate://bdbc6a41-ce36-4c14-9add-36306a46c95f context: type: object description: Various contextual properties to be used with `templateId`. properties: variables: type: array description: Variables to use within templates specified by `templateId`. items: type: object description: An individual variable ID and its value. The `value` property may take on multiple forms depending on the type of the variable specified in the [Variable Library](https://developers.everbridge.net/internal/reference/get_v1). properties: variableId: type: string description: The ID of the variable, as described by the Variable Library. value: oneOf: - type: string description: "A single string value for a variable. This would include single selection variables, textbox variables, textarea variables, and date variables. \n\n*Note:* It is recommended to send the value for date variables as an ISO 8601 date and time string (`2024-11-19T14:01:31Z`). The Communications API will automatically format the value based on the specified formatting of the variable in the Variable Library." - type: array description: Specifies multiple values for a variable. This is intended to be used with the multiple selection variable only. items: type: string contextIds: type: array description: IDs of contextual objects to use in the template. Each ID takes the form of `shortName://sourceID` where `shortName` is the property of the same name from the Context APIs and the `sourceID` is the identifier from the context source. Please see the documentation on the Context APIs for more information. maxItems: 1 items: type: string exercise: type: boolean description: Is enable exercise mode settings: $ref: '#/components/schemas/ApiSettings' message: $ref: '#/components/schemas/MessageContent' LaunchMode: type: string enum: - LIVE - SIMULATION description: "Adjust the behavior of the communication:\n * `LIVE`: Launch the communication and send notifications to all recipients. At least one recipient must be specified in `recipients`.\n * `SIMULATION`: Launch the communication but do not send notifications; useful for determining the impact of a communication before sending it with `Live`. At least one recipient must be specified in `recipients`." GenericOneWayBody: type: object description: The GenericOneWay public message content. required: - title - body - receiveUrls properties: title: type: string description: The title of generic one way. body: type: string description: The core content of generic one way. receiveUrls: type: string description: The receive url list of generic one way. items: type: string ContentAttachment: type: object properties: fileId: type: string fileName: type: string mimeType: type: string downloadUrl: type: string size: type: integer format: int64 Command: type: object required: - type properties: type: type: string description: The type of command to execute SenderSettings: type: object description: Specify what recipients will see as the "sender" of the notifications sent from the communication (e.g. caller ID upon receiving a phone call.) properties: email: type: object description: Configuration elements that control the display of the sender in email notifications. properties: name: type: string description: The display name used in email notifications. replyToEmail: type: string description: The "reply to" email address to use for email notifications. voice: type: array description: Configuration elements that control the display of the caller in phone call notifications. items: $ref: '#/components/schemas/VoiceSettings' sms: type: array description: Configuration elements that control the display of the sender in SMS notifications. items: $ref: '#/components/schemas/SmsSettings' AudioBulletinBoardBody: type: object description: The ABB public message content. required: - title - body - settingId properties: title: type: string description: The title of abb. body: type: string description: The core content of abb. settingId: type: string description: The setting id of abb that defined in setting page. audio: $ref: '#/components/schemas/ContentAttachment' expires: type: string description: How long the message expires. This is in formatted in the ISO 8601 "duration" format. example: PT5H AudioBody: description: When the delivery is of an audio format, the caller should expect the properties of this object to be present. allOf: - $ref: '#/components/schemas/MessageBody' - type: object properties: attachment: $ref: '#/components/schemas/ContentAttachment' contentType: type: string example: audio/mpeg description: The MIME type of the audio content. required: - attachmentId CemResultsLastKnownLocationType: type: object description: Specifies how to include contacts with "Last Known" location types in CEM Results. required: - type properties: type: type: string description: Must be set to exactly `LastKnown`. enum: - LastKnown locationSourceIds: type: array description: A list of location source IDs. items: type: number ProblemDetail: type: object description: An RFC-7807 compliant model for error details. properties: type: type: string description: A URI that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. status: type: integer description: The HTTP response status code describing the error. detail: type: string description: A human-readable explanation of the specific problem. instance: type: string description: A URI that identifies the specific problem. CemResultsNumberPropertyQuery: allOf: - $ref: '#/components/schemas/CemResultsPropertyQuery' - type: object required: - type description: Provides querying against numeric properties in Contacts and Assets. properties: type: type: string description: Must be set to exactly `Number`. enum: - Number lowerBound: type: number description: A lower bound to match against the properties. upperBound: type: number description: An upper bound to match against the properties. CapContent: type: object description: Shared CAP transport metadata for a public-safety delivery instance. The public-comms webpage shortUrl is not part of this content; it is system-generated and returned at the communication detail level. required: - capCategory - capEventType - capEventCode - capSeverity - capUrgency - capCertainty properties: capCategory: type: string description: CAP category. capEventType: type: string description: CAP event type. capEventCode: type: string description: CAP event code. capSeverity: type: string description: CAP severity. capUrgency: type: string description: CAP urgency. capCertainty: type: string description: CAP certainty. CemResultsExpectedLocationType: type: object description: Specifies how to include contacts with expected location types in CEM Results. required: - type properties: type: type: string description: Must be set to exactly `Expected`. enum: - Expected NetworkBody: type: object description: The Network public message content. required: - body - networkEffectTypes - affectedAreas - groupIds properties: body: type: string description: The core content of network. networkEffectTypes: type: array description: ' The type of network effect' items: type: string enum: - PUBLIC - NETWORK_GROUP affectedAreas: type: string description: The shape content. groupIds: type: array description: The groupIds defined in network setting page. items: type: string RecipientLogDownloadResponse: type: object properties: mode: type: string description: Whether the export completed synchronously or was queued asynchronously. enum: - SYNC - ASYNC taskId: type: string description: The export task ID for asynchronous exports. downloadUri: type: string description: The download URI for synchronous exports. TextOnlyPathCategory: type: string description: A group of contact path types that only support textual messaging. enum: - CATEGORY:BUSINESSMESSAGINGAPPS - CATEGORY:COMMON - CATEGORY:EMAIL - CATEGORY:MOBILEAPP - CATEGORY:PLAINTEXT - CATEGORY:SMS PatchCommRequest: type: object properties: title: type: string description: The new title or summary of the communication, shown in the Communications interface. This is not the title used in the notification. description: type: string description: The new description of the communication. This is not shown to recipients. maxLength: 500 eventType: type: string description: A new eventType for the communication. example: Wildfire active: description: Activate or deactivate the communication. example: false type: boolean AlertUsBody: type: object description: The AlertUs public message content. required: - title - body properties: title: type: string description: The title of web widget message. body: type: string description: The core content of web widget message. alertUsSettingId: type: string description: The soap web setting id that defined in setting page alertUsRestSetting: type: array description: The rest setting configuration list of alert us items: $ref: '#/components/schemas/AlertUsSetting' ApiDeliveryPathPrompt: type: object description: The unique description, provided by the organization, for the delivery path. required: - type - prompt properties: type: type: string description: Must be set to exactly `Prompt`. enum: - Prompt prompt: type: string description: The unique description, provided by the organization, for the delivery path. GroupRecipientId: type: object description: Refers to a group of contact recipients by a group ID. required: - type - id properties: type: type: string description: Must be set to exactly `Id`. enum: - Id id: type: string description: The contact group ID from the [Everbridge Groups API](https://developers.everbridge.net/internal/reference/ebs-list-groups). ResendCommRequest: type: object required: - recipients properties: mode: $ref: '#/components/schemas/LaunchMode' launchedFrom: type: string description: The source of the communication launch. This is used for tracking purposes and does not affect the behavior of the communication. Public should use API. enum: - API - UI - ORCHESTRATION - CRITICALEVENT - SAFETYMESSAGE - COMMSSCHEDULE - RESPONSEMGMT recipients: $ref: '#/components/schemas/LaunchRecipients' OperatorConfirmationRequest: type: object required: - contactIds properties: contactIds: type: array description: Contact info IDs to confirm. items: type: string pollingOptionIndex: type: - integer - 'null' format: int32 description: Optional polling option index. SemanticQuery: allOf: - $ref: '#/components/schemas/Command' description: A query use for generating a CEM Result built with semantic logic type: object properties: type: type: string description: The type of command to execute enum: - SemanticQuery inArea: $ref: '#/components/schemas/Geometry' starting: type: string format: date-time description: Optional start time for bounding the query. Affects some locations and travel itineraries. ending: type: string format: date-time description: Optional end time for bounding the query. Affects some locations and travel itineraries. ofTypeIds: type: array items: type: string description: A list of contact or asset type IDs to filter the results by. tagged: type: array items: type: string description: A list of tags to filter the results by. inPropertyIds: type: array items: type: string description: A list of property IDs to filter the results by. withProperties: type: array items: anyOf: - $ref: '#/components/schemas/CemResultsBooleanPropertyQuery' - $ref: '#/components/schemas/CemResultsNumberPropertyQuery' - $ref: '#/components/schemas/CemResultsStringPropertyQuery' description: A list of property IDs to filter the results by. named: type: array items: anyOf: - $ref: '#/components/schemas/CemResultsCompleteName' description: A list of names to filter the results by. identified: type: array items: type: string description: A list of identifiers to filter the results by. memberOfIds: type: array items: type: number description: A list of groups IDs to find members of. withLocationTypes: type: array items: anyOf: - $ref: '#/components/schemas/CemResultsStaticLocationType' - $ref: '#/components/schemas/CemResultsLastKnownLocationType' - $ref: '#/components/schemas/CemResultsExpectedLocationType' - $ref: '#/components/schemas/CemResultsTravelLocationType' description: A list of location types to filter the results by. ofRuleIds: type: array items: type: number description: A list of rules to filter the results by. isExpatriate: type: boolean description: If true, include expatriates in the results for contact result sets. isVip: type: boolean description: If true, include VIPs in the results for contact result sets. subscribedToIds: type: array items: type: string description: A list of public feed IDs to retrieve subscribers for. Only applicable to `publicuser` result sets. forZipCodes: type: array items: type: string description: A list of zipcodes to filter subscribers. Only applicable to `publicuser` result set. sendToAorSubscriptions: type: boolean description: If true, include org area-of-responsibility subscriptions. Only applicable to `publicuser` result set. ApiDeliveryPath: description: Delivery paths are ordered methods of contacting recipients, such as "work email" or "home phone". anyOf: - $ref: '#/components/schemas/ApiDeliveryPathPathId' - $ref: '#/components/schemas/ApiDeliveryPathPrompt' NetworkPublicMessage: type: object description: The Network public message content. required: - body - networkEffectTypes - affectedAreas - groupIds properties: body: type: string description: The core content of network. networkEffectTypes: type: array description: ' The type of network effect' items: type: string enum: - PUBLIC - NETWORK_GROUP affectedAreas: type: string description: The shape content. groupIds: type: array description: The groupIds defined in network setting page. items: type: string CemResultsStaticLocationType: type: object description: Specifies how to include contacts with static location types in CEM Results. required: - type properties: type: type: string description: Must be set to exactly `Static`. enum: - Static locationTypeIds: type: array description: A list of static location type IDs. items: type: number includeMissingLocationTypeId: type: boolean description: If true, include results that do not have a static location type. UserReference: description: The person who launched the communication and thus created the activity. type: object properties: id: description: The ID of the person. type: string example: '2389927572537387' username: description: The username of the person. type: string example: yunlong.an-vcc firstName: description: The first name of the person. type: string example: ethan-role lastName: description: The last name of the person. type: string example: an fullName: description: The full name of the person. type: string example: ethan-role an MemberPortalPublicMessage: type: object description: The member portal public message content. required: - body - includeSelectedMapShape properties: body: type: string description: The core content that displayed on public member public message page. includeSelectedMapShape: type: boolean description: 'Whether include the map defined in recipient part ' RoleItem: type: object properties: roleId: type: integer format: int64 description: The id of the role. role: $ref: '#/components/schemas/Role' TextualBody: description: When the delivery is of a non graphical text format, the caller should expect the properties of this object to be present. allOf: - $ref: '#/components/schemas/MessageBody' - type: object properties: content: type: string description: The text content to display or otherwise convert into another medium. required: - content Role: type: object properties: id: type: integer format: int64 description: The id of the role. name: type: string description: The name of the role. LaunchRecipients: type: object description: 'Describes the recipients of notifications from the communication. At least one recipient must be provided when `Mode` is `LIVE` or `SIMULATION`. **Note:** When specifying `recipients` in conjunction with a `templateId` in a request, the recipients specified here in the request will _replace_ any recipients defined in the template. Omitting `recipients` in the request will result in Communications using the recipients from the specified template. If the desired functionality is a merged set of recipients between the template and the request, the recipients from the template must be combined into a single `recipients` object in the request.' properties: contacts: type: array items: anyOf: - $ref: '#/components/schemas/ContactRecipientExternalId' - $ref: '#/components/schemas/ContactRecipientId' - $ref: '#/components/schemas/ContactRecipientName' - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of contact to send notifications to regardless of any other criteria. publicUsers: type: array items: anyOf: - $ref: '#/components/schemas/SemanticQuery' - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of `publicuser` queries that contain a set of `publicuser` to send notifications to. excluded: type: object description: Specifies recipients to exclude from notifications. properties: contacts: type: array items: anyOf: - $ref: '#/components/schemas/ContactRecipientExternalId' - $ref: '#/components/schemas/ContactRecipientId' - $ref: '#/components/schemas/ContactRecipientName' - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of contacts to exclude from notifications. groups: type: array items: anyOf: - $ref: '#/components/schemas/GroupRecipientId' - $ref: '#/components/schemas/GroupRecipientName' - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of contact groups to send notifications to regardless of any other criteria. query: type: array items: anyOf: - $ref: '#/components/schemas/ResultSetQueryRecipients' - $ref: '#/components/schemas/SemanticQuery' description: A set of contact queries that contain a set of contacts to send notifications to. rules: type: array items: anyOf: - $ref: '#/components/schemas/RuleRecipientId' - $ref: '#/components/schemas/RuleRecipientName' - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of contact rules (filters) to use when determining a set of contacts to send notifications to. alert: type: array items: anyOf: - $ref: '#/components/schemas/ResultSetQueryRecipients' description: A set of affected contacts from a CEM Alert. Twitter: type: object description: The Twitter custom message content. properties: body: type: string description: The core content sent to twitter.. imageId: type: string description: The system-generated image ID referring to the image file that will be sent to twitter webPageMessage: type: string description: The web page message sent to twitter image: $ref: '#/components/schemas/ContentAttachment' OperatorConfirmationResponse: type: object required: - success properties: success: type: boolean description: Whether the operation was successful. message: type: - string - 'null' description: Optional message with details. ThreadRecipientsResponse: type: array items: type: object properties: commId: description: The ID of the communication in the thread. type: string example: 3617cd9d-1815-4e35-9bfe-2a8def879956 resultsets: type: object description: A map of recipient source types to their corresponding CEM result set IDs. additionalProperties: type: string example: Group: evbg+result:contact:communications-f8114245-b70b-4907-9c87-87a9ebd5d38b:groups Individual: evbg+result:contact:communications-f8114245-b70b-4907-9c87-87a9ebd5d38b:individuals-0 Exclusion: evbg+result:contact:communications-f8114245-b70b-4907-9c87-87a9ebd5d38b:excludedIndividuals-0 required: - commId - resultsets CommRecipientAddress: type: object properties: location: type: string description: The location information street: type: string description: The street information. city: type: string description: The city information state: type: string description: The state information. country: type: string description: The country code. TextualMessageBody: allOf: - $ref: '#/components/schemas/LaunchMessageBody' - type: object required: - type - content - paths properties: attachments: type: array description: A set of system-generated IDs representing previously uploaded attachments. Note that attachments are aggregated across all message bodies (i.e. every message body gets the same attachments). items: type: string type: type: string description: A generic classifier of the message body, further refined by `contentType`. Must be set to exactly `Textual`. enum: - Textual content: type: string description: Text content to use as the body of the notification message. usePrefix: type: boolean description: If set to true, will prefix the message with organization-specific text prior to including the web page URL. Defaults to false. Currently only applies to message bodies with the `SMS` path category. paths: type: array description: "A set of contact delivery path types that this message body should be sent to.\n*Note*: Textual messages that are delivered to recipients using Audio path categories are read using text-to-speech. Text-to-speech is not available for the following languages:\n * Bengali (`bn_BD`)\n * Hebrew (`he_IL`)\n * Haitian Creole (`ht_HT`)\n * Indonesian (`id_ID`)\n * Thai (`th_TH`)\n * Ukrainian (`uk_UA`)\n * Urdu (`ur_PK`)\n * Vietnamese (`vi_VN`)\n * Yiddish (`yi_US`)" items: anyOf: - $ref: '#/components/schemas/AudioOnlyPathCategory' - $ref: '#/components/schemas/TextOnlyPathCategory' RuleRecipientName: type: object description: Refers to a contact rule (filter) by its name. Retrieve contact rule names using the [Everbridge Contact Filters API](https://developers.everbridge.net/internal/reference/ebs-v1-contact-filters) required: - type - name properties: type: type: string description: Must be set to exactly `Name`. enum: - Name name: type: string description: The name of the contact rule (filter). WebWidgetBody: type: object description: The web widget public message content. required: - title - body - stream properties: title: type: string description: The title of web widget message. body: type: string description: The core content of web widget message. ewwEndDate: type: string description: end date as an ISO 8601-compliant value to custom end data of web widget message.This value must be after the current date example: '2024-07-07T20:06:09.734385Z' stream: type: string description: The steam of web widget message. duration: type: string description: The amount of time, beginning at the web widget message launch, to expiring the message. This is in formatted in the ISO 8601 "duration" format. example: PT5H AlertUsPublicMessage: type: object description: The AlertUs public message content. required: - title - body properties: title: type: string description: The title of web widget message. body: type: string description: The core content of web widget message. alertUsSettingId: type: string description: The soap web setting id that defined in setting page alertUsRestSetting: type: array description: The rest setting configuration list of alert us items: $ref: '#/components/schemas/AlertUsSetting' PublishOptionMessageDeactivatedResponse: type: object properties: path: description: The message of which publish option path message deactivated type: string example: AudioBulletinBoard enum: - AudioBulletinBoard - WebWidget - MemberPortal status: description: The current status of the publish option path message type: string deactivatedDate: description: The datetime web widget message was deactivated type: string deactivatedBy: description: The user who deactivated web widget message type: string expireDateTime: description: The datetime when AudioBulletinBoard message was expired type: string questionnaire: type: object description: A list of answers to a provided question for recipients to respond with during confirmation. Note that this property is mutually exclusive with `conferenceBridgeId`; both may not be set in the same communication. required: - answers properties: answers: type: array items: type: object required: - name properties: name: type: string description: The user-friendly text of the questionnaire answer. responseQuota: type: integer description: Defines a minimum number of recipients that must respond with this questionnaire answer. questionText: type: string description: The text prompt to display to recipients when they are responding to the questionnaire. AlertUsSetting: type: object description: The rest alert us setting content required: - id - profileId properties: id: type: string description: The identity of alert us rest setting that pre-defined on alert us setting page. profileId: type: string description: The profile identity of alert us rest setting that pre-defined on alert us setting page.. duration: type: string description: The duration of the message,This is in formatted in the ISO 8601 "duration" format. example: PT5H groupNames: type: array description: The group name of alert us. items: type: string ApiSettings: type: object description: Settings that adjust how the communication is sent to the recipients. properties: id: type: string description: An optional ID of a preexisting set of settings. If provided along with any other settings in this object, the settings are merged so that any settings defined in this request override those stored in the settings at the given ID. defaultLanguage: $ref: '#/components/schemas/SupportedLanguages' sender: $ref: '#/components/schemas/SenderSettings' delivery: $ref: '#/components/schemas/DeliverySettings' recipientInteraction: $ref: '#/components/schemas/RecipientSettings' ContextData: type: object properties: contextIds: type: array items: type: string description: The context IDs of any context objects used for the communication. values: type: array description: Values, including variables, identified within the communication. items: type: object description: An individual value. properties: variableId: type: string description: The ID of a variable that was used to render the value. Values extracted from context objects (e.g. alerts) may not have an ID. label: type: string description: A human-friendly name for this value. value: type: string description: The rendered value, if any. rawValue: description: An unformatted value. This is intended for resubmitted a variable value from a previous communication in an update to an existing communication or in a new communication that uses the same variable. Not supported by values extracted from context objects (e.g. alerts). oneOf: - type: string description: A single string value for a variable. This includes single selection variables, textbox variables, textarea variables, and date variables. - type: array description: Specifies multiple values for a variable. This is intended to be used with the multiple selection variable only. items: type: string type: type: string description: "Describes where the value was sourced from:\n\n * `Variable`: The value was sourced from a custom variable.\n * `Context`: The value was sourced from a context object such as an alert." enum: - Context - Variable ContactRecipientId: type: object description: Refers to a contact recipient by its contact ID. required: - type - id properties: type: type: string description: Must be set to exactly `Id`. enum: - Id id: type: string description: The contact ID from the [Everbridge Contacts API](https://developers.everbridge.net/internal/reference/ebs-list-contacts). CommRecipientLog: type: object properties: recipientId: type: string description: The id of recipient. contactLogId: type: string description: The contact log id. fullName: type: string description: The full name of recipient. externalId: type: string description: The external ID of recipient. recipientSources: type: array description: Information of the way that recipient was selected. items: $ref: '#/components/schemas/CommRecipientSource' recipientAddress: type: array description: Information of the current recipient's address. items: $ref: '#/components/schemas/CommRecipientAddress' status: type: string description: The status of the current record enum: - Duplicate - Unreachable - Attempted - ConfirmedLate - Confirmed firstAttemptDate: description: Time of the first delivery. type: string format: date-time latestAttemptDate: description: Time of the latest delivery. type: string format: date-time confirmDate: type: string description: Time of confirm the current communication. format: date-time confirmedPathCategory: type: string description: The specific confirmed path category. confirmedPathId: type: string description: The specific confirmed path ID. confirmedPathName: type: string description: The specific confirmed path name. confirmedPathValue: type: string description: The specific confirmed path value. pollResponse: description: The poll response value that current recipient response. type: string recipientLogByPath: description: The detail information of recipient log per path. type: array items: $ref: '#/components/schemas/CommRecipientLogPerPath' WebPageMessageBody: allOf: - $ref: '#/components/schemas/LaunchMessageBody' - type: object description: '' required: - type - content - paths properties: attachments: type: array description: A set of system-generated IDs representing previously uploaded attachments. Note that attachments are aggregated across all message bodies (i.e. every message body gets the same attachments). items: type: string type: type: string description: A generic classifier of the message body, further refined by `contentType`. Must be set to exactly `WebPage`. enum: - WebPage content: type: string description: Text content to use as the body of the web page. paths: type: array description: A set of contact delivery path types or path categories that this message body should be sent to. items: type: string enum: - CATEGORY:SMS usePrefix: type: boolean description: If set to true, will prefix the message with organization-specific text prior to including the web page URL. Defaults to false. additionalContent: type: string description: Optional additional plain text content to send with the initial message. Not included in the web page. RenderedTextContent: description: A rendered text content object. allOf: - $ref: '#/components/schemas/ContentMetadata' - type: object properties: attachments: type: array description: A list of attachments. items: $ref: '#/components/schemas/ContentAttachment' MessageDetailBody: type: object description: This is the base object that AudioBody, TextualBody, WebpageBody and all kinds of public message body is build upon. properties: questionnaire: $ref: '#/components/schemas/questionnaire' content: anyOf: - $ref: '#/components/schemas/AudioBody' - $ref: '#/components/schemas/TextualBody' - $ref: '#/components/schemas/WebPageBody' - $ref: '#/components/schemas/WebWidgetBody' - $ref: '#/components/schemas/AlertUsBody' - $ref: '#/components/schemas/GenericOneWayBody' - $ref: '#/components/schemas/AudioBulletinBoardBody' - $ref: '#/components/schemas/SocialMediaBody' - $ref: '#/components/schemas/MemberPortalBody' - $ref: '#/components/schemas/NetworkBody' WebPageBody: description: When the delivery is of a HTML format, the caller should expect the properties of this object to be present. allOf: - $ref: '#/components/schemas/MessageBody' - type: object properties: content: type: string description: Plain or rich text content of the message. contentType: type: string example: text/html usePrefix: type: boolean description: If true, adds additional prefix text to the SMS message. prefix: type: string description: I additional prefix text to the SMS message. smsContent: type: string description: Optional additional content to provide in the SMS message. required: - content SocialMediaBody: type: object description: The social media public message content. required: - tokenIds - incLink properties: body: type: string description: The title of social media. tokenIds: type: array description: The tokens of social media ,it can contain the token of both twitter and facebook. items: type: string incLink: type: boolean description: Whether the message publish to social media contains a link image: $ref: '#/components/schemas/ContentAttachment' customContents: type: array description: The bodies of the custom social media Each type at most has one item. items: anyOf: - $ref: '#/components/schemas/Facebook' - $ref: '#/components/schemas/Twitter' AbstractApiPaginatedResponse: type: object description: A page of data from an endpoint. properties: data: type: array items: $ref: '#/components/schemas/CommData' pages: type: object properties: currentPage: type: number description: The requested page number. pageSize: type: number description: The requested page size. pageCount: type: number description: The number of elements in the current page. totalPages: type: number description: The total number of pages available for request. maxSize: type: number description: The maximum size of a single page that is allowed by the API. totalCount: type: number description: The total number of elements across all pages. AudioMessageBody: allOf: - $ref: '#/components/schemas/LaunchMessageBody' - type: object required: - type - attachmentId - paths properties: attachmentId: type: string description: The system-generated attachment ID referring to the audio file for this message. type: type: string description: A generic classifier of the message body, further refined by `contentType`. Must be set to exactly `Audio`. enum: - Audio paths: type: array description: A set of contact delivery path types that this message body should be sent to. items: $ref: '#/components/schemas/AudioOnlyPathCategory' RuleRecipientId: type: object description: Refers to a group of contact rules (filters) by an ID. Retrieve contact rule IDs using the [Everbridge Contact Filters API](https://developers.everbridge.net/internal/reference/ebs-v1-contact-filters) required: - type - id properties: type: type: string description: Must be set to exactly `Id`. enum: - Id id: type: string description: The contact rule (filter) ID. SmsSettings: type: object description: The SMS short code or phone number shown to recipients of text messages. required: - countryCode - smsId properties: countryCode: type: string description: The ISO 3166 two-letter code for the country where this phone number is valid. Please refer to [the Wikipedia page on ISO 3166 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) for valid values. smsId: type: string description: The SMS ID to use when sending SMS messages to recipients residing in the country specified by `countryCode`. pattern: '^[a-zA-Z0-9]+(?: [a-zA-Z0-9]+)?$' minLength: 1 maxLength: 11 CommDetail: type: object properties: commId: description: The ID of the communication. example: a5a71f87-4f3b-472f-a39d-47cc1c3c9b30 type: string title: description: The title and possible subject of the communication. example: Test Communication type: string description: type: string description: A description of the communication. This is not shown to recipients. example: This is a test communication. mode: description: Describes the behavior of the communication. example: Live type: string enum: - Live - Simulation - Preview status: description: The current status of the communication. example: READY type: string enum: - CANCELLED - FAILED - PROCESSING - READY - SCHEDULED - SENT organizationId: description: The Everbridge organization ID that owns the communication. example: '135975236674' type: string created: description: The date and time the communication was created. example: 2024-02-06T20:00:00+0000 type: string format: date-time updated: description: The date and time the communication was last updated. example: 2024-02-06T20:00:00+0000 type: string format: date-time notifications: description: A list of notifications associated with the communication. type: array items: type: object properties: notificationId: description: The ID of the notification. example: notification://a5a71f87-4f3b-472f-a39d-47cc1c3c9b30 type: string status: description: The current status of the notification. example: READY type: string enum: - CANCELLED - FAILED - PROCESSING - READY - SENT tags: type: array items: $ref: '#/components/schemas/Tag' description: A list of tags assigned to the communication. userId: description: The ID of the user that launched the communication. example: '136578946518096' type: string contents: description: A list of contents associated with the communication. type: array items: $ref: '#/components/schemas/RenderedContent' priority: description: Priority of the communication example: NORMAL type: string enum: - NORMAL - HIGHPRIORITY - LIFETHREATENING name: description: Name of the communication. example: Test Communication type: string eventType: description: Type of event example: TODO type: string launchedBy: type: string description: The full name of the user who launched this communication publicSafety: type: boolean description: Communication is being sent as a Public Safety message launchedFrom: type: string description: The source of the communication launch. This is used for tracking purposes and does not affect the behavior of the communication. Public should use API. enum: - API - UI - ORCHESTRATION - CRITICALEVENT - SAFETYMESSAGE - COMMSSCHEDULE - RESPONSEMGMT roleItem: $ref: '#/components/schemas/RoleItem' sent: description: Time the communication was sent. example: Test Communication type: string format: date-time active: description: Communication is active or not example: 'true' type: boolean contentMetadata: $ref: '#/components/schemas/CommContentMetadata' templateId: description: The identifier of the template used for the communication. example: 2024-02-06T20:00:00+0000 type: string format: d122a3f7-882f-4b44-a20b-124d07c58f5b closedBy: description: The full name of the user from the latest CLOSE activity, present only when the communication is inactive and the user can be resolved. type: string closedAt: description: The date and time the communication was closed, present only when the communication is inactive. example: 2024-02-06T20:00:00+0000 type: string format: date-time activatedBy: description: The full name of the user from the latest REOPEN activity, present only when the communication is active and the user can be resolved. type: string activatedAt: description: The date and time from the latest REOPEN activity, present only when the communication is active. example: 2024-02-06T20:00:00+0000 type: string format: date-time errors: type: array items: $ref: '#/components/schemas/PublicCommError' description: A list of errors associated with the communication. planId: type: string description: The ID of the plan that launched the with communication, if any. ResultSetQueryRecipients: type: object description: An ID of an existing CEM Results result set where the contacts cached within the result set are included as recipients in the communication. required: - type - id properties: type: type: string description: Must be set to exactly `ResultSet`. enum: - ResultSet id: type: string description: A valid result set ID. Must represent a set of entities that can be contacted (e.g. contacts, not assets). example: evbg+result:contact:cemp-1234567890abcdef01234567-abcdef01-2345-6789-abcd-ef0123456789:1697471720114 RecipientSettings: type: object description: Settings that adjust how recipients respond to the communication. properties: confirm: type: boolean description: Request that recipients confirm that the notification was received. smsCallback: type: boolean description: Request that SMS recipients call to confirm delivery. voiceMailOption: type: string description: "Control how the system responds if it is sent to a recipient's voicemail inbox:\n * `MESSAGEONLY`: Leave a message but do not consider the notification confirmed.\n * `MESSAGEWITHCONFIRMATION`: Leave a message and consider the notification confirmed.\n * `NOMESSAGE`: Do not leave a message; the notification is not confirmed." enum: - MESSAGEONLY - MESSAGEWITHCONFIRMATION - NOMESSAGE mobileSettings: type: object properties: requestImage: type: boolean description: Request an image of recipients and their surroundings. requestLocation: type: boolean description: Request that recipients share their location. allowShare: type: boolean description: Allow recipients to share the message with others. requireConfirm: type: boolean description: Require that recipients confirm receipt. requestComment: type: boolean description: Request that recipients reply to the notification with a brief description of their status. CemResultsBooleanPropertyQuery: allOf: - $ref: '#/components/schemas/CemResultsPropertyQuery' - type: object required: - type description: Provides querying against boolean properties in Contacts and Assets. properties: type: type: string description: Must be set to exactly `Boolean`. enum: - Boolean value: type: boolean description: A boolean value to match against the properties. GroupRecipientName: type: object description: Refers to a group of contact recipients by a name as shown in the [Everbridge Groups API](https://developers.everbridge.net/internal/reference/ebs-list-groups). required: - type - name properties: type: type: string description: Must be set to exactly `Name`. enum: - Name name: type: string description: The name of the contact group. CemResultsPropertyQuery: type: object required: - ids properties: ids: type: array description: The IDs of the properties to query by. CemResultsStringPropertyQuery: allOf: - $ref: '#/components/schemas/CemResultsPropertyQuery' - type: object required: - type description: Provides querying against string properties in Contacts and Assets. properties: type: type: string description: Must be set to exactly `String`. enum: - String values: type: array description: The values to match against the properties. items: type: string WebWidgetPublicMessage: type: object description: The web widget public message content. required: - title - body - stream properties: title: type: string description: The title of web widget message. body: type: string description: The core content of web widget message. ewwEndDate: type: string description: end date as an ISO 8601-compliant value to custom end data of web widget message.This value must be after the current date example: '2024-07-07T20:06:09.734385Z' stream: type: string description: The steam of web widget message. duration: type: string description: The amount of time, beginning at the web widget message launch, to expiring the message. This is in formatted in the ISO 8601 "duration" format. example: PT5H RenderedContent: oneOf: - $ref: '#/components/schemas/RenderedTextContent' CommsResponse: required: - id type: object properties: id: type: string description: The ID of the communication that was launched. CAPPublicMessage: type: object description: A CAP public-message body targeted at one or more CAP modalities (paths). Shared CAP transport metadata is carried under `cap`. Multiple CAP public messages are allowed as long as their paths do not overlap. required: - paths - cap properties: body: type: string description: The CAP message body for the targeted modalities. paths: type: array description: The CAP delivery modalities this body applies to. A modality may be targeted by at most one CAP public message. items: type: string enum: - IPAWS - CAP_GOOGLE - CAP_RSS cap: $ref: '#/components/schemas/CapContent' CemResultsTravelLocationType: type: object description: Specifies how to include contacts with travel location types in CEM Results. required: - type properties: type: type: string description: Must be set to exactly `Travel`. enum: - Travel domesticInternationalStatuses: type: array description: A list of domestic international travel statuses. items: type: string localTravelStatuses: type: array description: A list of local travel statuses. items: type: string travelTypes: type: array description: Depicts whether a contact is arriving, departing, or transitioning to a location. items: type: string enum: - Arrival - Departure - Transit segmentTypes: type: array description: Depicts a contact's mode of transportation to a location. items: type: string enum: - Car - Hotel - Air - Rail ConfirmationByPathSummary: description: Confirmation by path summary associated with the communication. type: object properties: sms: description: Count of confirmation by sms type: integer example: '8' email: description: Count of confirmations by email type: integer example: '3' mobileApp: description: Count of confirmations by mobile app type: integer example: '4' plainText: description: Count of confirmations by plain text type: integer example: '1' voice: description: Count of confirmations by voice type: integer example: '0' businessMessagingApps: description: Count of confirmations by business messageing apps type: integer example: '0' Geometry: type: object description: A geojson representation of a map shape. AudioOnlyPathCategory: type: string description: A group of contact path types that only support audio messaging. enum: - CATEGORY:VOICE securitySchemes: API_Authorizer: type: apiKey name: Authorization in: header x-amazon-apigateway-authtype: custom x-amazon-apigateway-authorizer: authorizerUri: arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:214792946631:function:API_Authorizer_us-east-1_prod:live/invocations authorizerCredentials: arn:aws:iam::214792946631:role/comms-unified-gateway-prod-us-us-east-1-0-us-east-1-gw authorizerResultTtlInSeconds: 300 identitySource: method.request.header.Authorization,method.request.header.PathCacheKey,method.request.header.MethodCacheKey type: request api_key: type: apiKey name: x-api-key in: header x-readme: explorer-enabled: true proxy-enabled: true