JUMP TOEnterprise Communications APIEnterprise Communications API OverviewCalling the Enterprise Communications APIAddressing your messagesMessage sending across channelsCustom messagesMulti part messagesTemplatesChannel selectionAdditional optionsMessage send responseInbound messages and receiptsChannelsSMSMMSPushWhatsAppFacebookApp MessagingCustom ChannelsBranchWebhooksWebhooksMessage EventsProfile EventsFacebook EventsApp Messaging - Conversation EventsApp Messaging - Message EventsApp Messaging - Session EventsChat - EventsChat - Message EventsChat - Presence EventsApp MessagingApp Messaging OverviewAndroidInstalling the SDKInitialiseStart sessionClient APIsListen to eventsPush messagesMessaging serviceProfile serviceiOSInstalling the SDKInitialiseStart sessionPush messagesListen to eventsClient APIsProfile servicesMessaging servicesJavaScriptInstall the SDKInitialiseCreate conversationSend messageQuery conversationsQuery conversation messagesQuery eventsWebsocket eventsMessage status updatesProfile APITypescriptCordovaChatChat APIWeb Chat WidgetAndroid ChatInstalling the SDKInitialiseChat StoreStart sessionClient APIsListen to eventsMessaging serviceProfile serviceJavaScript ChatInstall the Chat SDKInitialise the Chat SDKChat Conversation StoreChat Client APIsChat Client EventsChat Client Messaging ServiceiOS ChatInstalling the SDKInitialiseChat StoreStart sessionProfile servicesMessaging servicesListen to eventsClient APIsSMSSMS API OverviewSMS ReferenceSMS Message EncodingSMS Message SegmentationSMS Message StatusesVerifyVerify APICreate and Send CodeValidate CodeVerify Error CodesEnterprise Communications Message API/apispaces/{apiSpaceId}/messages/{messageId}/statuses/{status}Posts a status for a messagepost/apispaces/{apiSpaceId}/messages/{messageId}Retrieves the current state of a specific message.getDeletes a MessagedeletePatches a Messagepatch/apispaces/{apiSpaceId}/messagesSend a new messagepost/apispaces/{apiSpaceId}/messages/batchSend a batch of new messagespost/apispaces/{apiSpaceId}/messages/inboundsPosts an inbound messagepost/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}/statuses/{status}Posts a status for an inboundpostMessage History API/apispaces/{apiSpaceId}/profiles/{profileId}/messagesRetrieves message history for the specified profile. Messages retrieved from the date spacified (default now), in descending time order.getContent API/apispaces/{apiSpaceId}/content/{fileId}Retrieve a filegetProfile API/apispaces/{apiSpaceId}/profiles/exportExports the result of a profile query in a formatted file for downloadpost/apispaces/{apiSpaceId}/profiles/bulkDeletes the requested profilesdeleteCreates or updates the supplied profiles with the supplied datapatch/apispaces/{apiSpaceId}/profiles/{id}Retrieves a ProfilegetUpdates or undeletes a ProfileputDeletes a ProfiledeletePatches a Profilepatch/apispaces/{apiSpaceId}/profiles/{id}/optinSet profile opt in for specified channelsputSet profile opt in for specified channelsdelete/apispaces/{apiSpaceId}/profiles/{id}/rels/primary/{linkedId}Creates a relationship where the linked profile is the primary and this profile is a childputDeletes the profile's relationship to a primary profiledelete/apispaces/{apiSpaceId}/profiles/{id}/rels/link/{linkedId}Creates a relationship where this profile is the primary and the linked profile is a childputDeletes the primary profile's relationship to a linked Profiledelete/apispaces/{apiSpaceId}/profilesQuery profilesgetCreates a new Profilepost/apispaces/{apiSpaceId}/profiles/importStart the import processpost/apispaces/{apiSpaceId}/profiles/optinGets default profiles opt in/out options for each channel in channel servicegetSet default profiles opt in/out options for each channel in channel serviceput/apispaces/{apiSpaceId}/profiles/import/{id}/duplicatesGet information about duplicated profilesget/apispaces/{apiSpaceId}/profiles/import/{id}/startStart the import processput/apispaces/{apiSpaceId}/audiences/{id}Retrieves an audiencegetUpdates an audienceputDeletes an audiencedelete/apispaces/{apiSpaceId}/audiencesQuery audiencegetCreates a new audiencepostConversation API/apispaces/{apiSpaceId}/conversations/{conversationId}Retrieves a conversationgetUpdates a conversationputDeletes a conversationdelete/apispaces/{apiSpaceId}/conversationsRetrieves a list of conversationsgetCreates a new conversationpost/apispaces/{apiSpaceId}/conversations/{conversationId}/typingIndicates that the caller is typing in this conversationpostIndicates that the caller has stopped typing in this conversationdelete/apispaces/{apiSpaceId}/conversations/{conversationId}/participantsRetrieves the conversation participantsgetAdds a list of participants to a conversationpostDeletes a list of participants from a conversationdeleteConversation Message API/apispaces/{apiSpaceId}/conversations/{conversationId}/eventsRetrieves a conversation's eventsget/apispaces/{apiSpaceId}/conversations/{conversationId}/messagesRetrieves a conversation's messages from an point (event) in time and works backwardsgetSends a message to conversationpost/apispaces/{apiSpaceId}/conversations/{conversationId}/messages/statusupdatesPosts message updates backpostAnalytics API/apispaces/{apiSpaceId}/analytics/conversationmessagesRetrieves conversation message analyticsget/apispaces/{apiSpaceId}/analytics/messagesRetrieves message analyticsget/apispaces/{apiSpaceId}/analytics/sessionsRetrieves session analyticsget/apispaces/{apiSpaceId}/analytics/sms/trackingRetrieves url tracking analyticsget/apispaces/{apiSpaceId}/analytics/sms/verifyRetrieves sms verify analyticsget/apispaces/{apiSpaceId}/analytics/sms/inboundRetrieves inbound SMS analyticsget/apispaces/{apiSpaceId}/analytics/sms/outboundRetrieves outbound SMS analyticsgetAPI Space Management API/apispaces/{id}Retrieves an API SpacegetUpdates an API SpaceputDeletes an API spacedelete/apispacesRetrieves all API Spaces accessible by the current usergetCreates a new API Spacepost/apispaces/{id}/authRetrieves an API Space's authentication configurationgetUpdates an API Space's authentication configurationput/apispaces/{id}/pushRetrieves an API Space's push configurationget/apispaces/{id}/retentionRetrieves an API Space's data retention configurationgetUpdates an API Space's data retention configurationput/apispaces/{id}/push/apnsUpdates an API Space's APNS push certificate configurationput/apispaces/{id}/push/apns/{bundleId}/{environment}Deletes a specific bundle from an API Space's APNS push configurationdelete/apispaces/{id}/push/apns/{bundleId}/{environment}/certRetrieves a bundle's APNS certificateget/apispaces/{id}/push/apnstokenUpdates an API Space's APNS push token configurationputDeletes the APNS push token configuration from an API Space's APNS push configurationdelete/apispaces/{id}/push/apnstoken/keyRetrieves the APNS key file for the API Spaceget/apispaces/{id}/push/fcm/v1/{package}Updates an API Space's FCM push configurationputBilling API/accounts/{accountId}/tariffRetrieves an account's tariffget/accounts/{accountId}/transactionsRetrieves an account's transaction history. Spends such as monthly profile bill, SMS message sends, PNV lookups and SMS inbound numbers appear as debits, i.e. negative amounts. Invoice or card payments appear as positive credits to the account.getSession API/apispaces/{apiSpaceId}/sessions/tokens/anonGets a token that can be used to start an anonymous sessionget/apispaces/{apiSpaceId}/sessions/{id}Retrieves details about a sessiongetEnds a session, revoking access to services.deleteWebhook API/apispaces/{apiSpaceId}/webhooksRetrieves a webhook configurationgetCreate a webhook configurationpost/apispaces/{apiSpaceId}/webhooks/availableeventsRetrieves a webhook available eventsget/apispaces/{apiSpaceId}/accesstokens/availabletemplatesGets a list of available events templates that the caller can use when creating webhookget/apispaces/{apiSpaceId}/webhooks/{webhookId}Retrieves a webhook configurationgetUpdates a webhook configurationputDeletes a webhook configurationdeleteChat API/apispaces/{apiSpaceId}/chats/{chatId}Retrieves a chatgetUpdates a chatputDeletes a chatdelete/apispaces/{apiSpaceId}/chats/{chatId}/assignAssigns a chatput/apispaces/{apiSpaceId}/chats/{chatId}/closeCloses a chatput/apispaces/{apiSpaceId}/chats/{chatId}/channelChanges the channel for an existing chatput/apispaces/{apiSpaceId}/chats/{chatId}/formSends a form to a chatpost/apispaces/{apiSpaceId}/chatsRetrieves a list of chatsgetCreates a new chatpost/apispaces/{apiSpaceId}/chats/{chatId}/typingIndicates that the caller is typing in this chatpostIndicates that the caller has stopped typing in this chatdelete/apispaces/{apiSpaceId}/chats/{chatId}/participantsRetrieves the chat participantsgetChat Message API/apispaces/{apiSpaceId}/chats/{chatId}/eventsRetrieves a chat's eventsget/apispaces/{apiSpaceId}/chats/{chatId}/messagesRetrieves a chat's messages from an point (event) in time and works backwardsgetSends a message to chatpost/apispaces/{apiSpaceId}/chats/{chatId}/messages/statusupdatesPosts message updates backpostChat Config API/apispaces/{apiSpaceId}/chat/configRetrieves the chat configuration for an apiSpaceget/apispaces/{apiSpaceId}/chat/config/teams/{teamId}Retrieves the members of a teamgetRemoves the config for a teamdelete/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/smsUpdate the SMS config for a teamputRemoves the SMS config for a teamdelete/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/fbMessengerUpdate the Facebook Messenger config for a teamputRemoves the Facebook Messenger config for a teamdelete/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/appMessagingUpdate the App Messaging config for a teamputRemoves the App Messaging config for a teamdelete/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/emailUpdate the email config for a teamputRemoves the email config for a teamdelete/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/settingsUpdate general settings for a teamputRemoves the settings for a teamdeleteReferenceMIME TypesChannelsThis section covers the channels the Enterprise Communications API supports:
