Introduction
REST Resources
This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
- AttachmentEndpoint
- ConfigEndpoint
- CrmEndpoint
- ExternalAccountEndpoint
- FeedbackEndpoint
- GroupEndpoint
- MessageEndpoint
- MsisdnEndpoint
- ProUserEndpoint
- RegistrationEndpoint
- RemoteCallEndpoint
- RemoteSmsEndpoint
- ShopEndpoint
- SmsConnectorEndpoint
- SmsEndpoint
- TypingEndpoint
- UserCallEndpoint
- UserContactEndpoint
- UserDeviceEndpoint
- UserEndpoint
- UserMessageEndpoint
- UserSmsConnectorEndpoint
- UserSubscriptionEndpoint
The REST resources expose a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.
There is also a WADL document describing the REST API.
Swagger
You may also enjoy the Swagger UI provided for this API.
Data Model
All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.
This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.
Namespace "ns0"
Namespace URI: | (default namespace) |
XSD: | ns0.xsd |
Data Elements
- attachmentAddPartRequest
- attachmentAddPartResponse
- attachmentAllowMsisdnsRequest
- attachmentAllowMsisdnsResponse
- attachmentCreateRequest
- attachmentCreateResponse
- attachmentGetPartsRequest
- attachmentGetPartsResponse
- attachmentUploadedPartRequest
- attachmentUploadedPartResponse
- configGetCountriesRequest
- configGetCountriesResponse
- configGetProductsRequest
- configGetProductsResponse
- crmMessageClickedRequest
- crmMessageClickedResponse
- crmMessageViewedRequest
- crmMessageViewedResponse
- externalAccountConnectRequest
- externalAccountConnectResponse
- externalAccountCreateRequest
- externalAccountCreateResponse
- externalAccountDeleteRequest
- externalAccountDeleteResponse
- externalAccountDisconnectRequest
- externalAccountDisconnectResponse
- externalAccountGetTokenRequest
- externalAccountGetTokenResponse
- externalAccountInitiateRequest
- externalAccountInitiateResponse
- externalAccountLoginRequest
- externalAccountLoginResponse
- externalAccountValidateRequest
- externalAccountValidateResponse
- feedbackSendRequest
- feedbackSendResponse
- groupCreateRequest
- groupCreateResponse
- groupGetGroupsRequest
- groupGetGroupsResponse
- groupGetUsersRequest
- groupGetUsersResponse
- groupInviteUsersRequest
- groupInviteUsersResponse
- groupLeaveRequest
- groupLeaveResponse
- groupRenameRequest
- groupRenameResponse
- groupSendMessageRequest
- groupSendMessageResponse
- messageSendRequest
- messageSendResponse
- msisdnVerifyCallRequest
- msisdnVerifyCallResponse
- msisdnVerifyCheckKeyRequest
- msisdnVerifyCheckKeyResponse
- msisdnVerifyCheckPinRequest
- msisdnVerifyCheckPinResponse
- msisdnVerifyCreateKeyRequest
- msisdnVerifyCreateKeyResponse
- msisdnVerifyRequest
- msisdnVerifyResponse
- msisdnVerifyStatusRequest
- msisdnVerifyStatusResponse
- proUserAddRequest
- proUserAddResponse
- proUserCheckRequest
- proUserCheckResponse
- registrationActivateMsisdnRequest
- registrationActivateMsisdnResponse
- registrationActivateRequest
- registrationActivateResponse
- registrationCheckMsisdnRequest
- registrationCheckMsisdnResponse
- registrationCreateKeyRequest
- registrationCreateKeyResponse
- registrationCreateRequest
- registrationCreateResponse
- remoteCallControlRequest
- remoteCallControlResponse
- remoteCallFailedRequest
- remoteCallFailedResponse
- remoteCallInitiateRequest
- remoteCallInitiateResponse
- remoteSmsCancelRequest
- remoteSmsCancelResponse
- remoteSmsFailedRequest
- remoteSmsFailedResponse
- remoteSmsResendRequest
- remoteSmsResendResponse
- remoteSmsSendRequest
- remoteSmsSendResponse
- remoteSmsSentRequest
- remoteSmsSentResponse
- shopCheckPaymentRequest
- shopCheckPaymentResponse
- shopGetPaymentMethodsRequest
- shopGetPaymentMethodsResponse
- shopRedeemTokenRequest
- shopRedeemTokenResponse
- shopStartPaymentRequest
- shopStartPaymentResponse
- smsConnectorCreateRequest
- smsConnectorCreateResponse
- smsConnectorGetConnectorsRequest
- smsConnectorGetConnectorsResponse
- smsSendRequest
- smsSendResponse
- smsSendSponsoredRequest
- smsSendSponsoredResponse
- typingFireEventRequest
- typingFireEventResponse
- userCallCountUnreadRequest
- userCallCountUnreadResponse
- userCallDeleteAllRequest
- userCallDeleteAllResponse
- userCallDeleteListRequest
- userCallDeleteListResponse
- userCallGetCallsRequest
- userCallGetCallsResponse
- userCallInsertRequest
- userCallInsertResponse
- userCallReadAllRequest
- userCallReadAllResponse
- userCallSyncRequest
- userCallSyncResponse
- userCallUpdateRequest
- userCallUpdateResponse
- userChangePasswordRequest
- userChangePasswordResponse
- userContactGetA2aMsisdnsRequest
- userContactGetA2aMsisdnsResponse
- userContactGetContactsRequest
- userContactGetContactsResponse
- userContactOverrideUpdateRequest
- userContactOverrideUpdateResponse
- userContactSyncRequest
- userContactSyncResponse
- userCreateRequest
- userCreateResponse
- userDeleteRequest
- userDeleteResponse
- userDeviceClientDeleteRequest
- userDeviceClientDeleteResponse
- userDeviceClientGetRequest
- userDeviceClientGetResponse
- userDeviceCreateRequest
- userDeviceCreateResponse
- userDeviceUpdateRequest
- userDeviceUpdateResponse
- userGetBalanceRequest
- userGetBalanceResponse
- userGetFeatureRequest
- userGetFeatureResponse
- userGetSettingRequest
- userGetSettingResponse
- userGetSmsRoutingRequest
- userGetSmsRoutingResponse
- userLoginRequest
- userLoginResponse
- userMessageDeleteConversationListRequest
- userMessageDeleteConversationListResponse
- userMessageDeleteConversationRequest
- userMessageDeleteConversationResponse
- userMessageDeleteListRequest
- userMessageDeleteListResponse
- userMessageDeleteRequest
- userMessageDeleteResponse
- userMessageGetConversationsRequest
- userMessageGetConversationsResponse
- userMessageGetMessagesRequest
- userMessageGetMessagesResponse
- userMessageInsertRequest
- userMessageInsertResponse
- userMessageLockListRequest
- userMessageLockListResponse
- userMessageReadConversationRequest
- userMessageReadConversationResponse
- userMessageSearchRequest
- userMessageSearchResponse
- userMessageSendRequest
- userMessageSendResponse
- userMessageSyncRequest
- userMessageSyncResponse
- userMessageUnlockListRequest
- userMessageUnlockListResponse
- userMessageUpdateRequest
- userMessageUpdateResponse
- userResetPasswordRequest
- userResetPasswordResponse
- userSetSettingRequest
- userSetSettingResponse
- userSetSmsRoutingRequest
- userSetSmsRoutingResponse
- userSmsConnectorGetConnectorsExtendedRequest
- userSmsConnectorGetConnectorsExtendedResponse
- userSmsConnectorSetConnectorsRequest
- userSmsConnectorSetConnectorsResponse
- userSubscriptionActivateRequest
- userSubscriptionActivateResponse
- userSubscriptionDeactivateRequest
- userSubscriptionDeactivateResponse
- userSubscriptionGetRequest
- userSubscriptionGetResponse
- userSubscriptionLaunchRequest
- userSubscriptionLaunchResponse
- userSubscriptionLogRequest
- userSubscriptionLogResponse
- userVerifyMsisdnRequest
- userVerifyMsisdnResponse
Data Types
- amazonS3Upload
- attachmentAddPartRequest
- attachmentAddPartResponse
- attachmentAllowMsisdnsRequest
- attachmentAllowMsisdnsResponse
- attachmentCreateRequest
- attachmentCreateResponse
- attachmentGetPartsRequest
- attachmentGetPartsResponse
- attachmentPart
- attachmentUploadedPartRequest
- attachmentUploadedPartResponse
- authRequest
- configCountry
- configGetCountriesRequest
- configGetCountriesResponse
- configGetProductsRequest
- configGetProductsResponse
- configProduct
- crmMessageClickedRequest
- crmMessageClickedResponse
- crmMessageViewedRequest
- crmMessageViewedResponse
- externalAccountConnectRequest
- externalAccountConnectResponse
- externalAccountCreateRequest
- externalAccountCreateResponse
- externalAccountDeleteRequest
- externalAccountDeleteResponse
- externalAccountDisconnectRequest
- externalAccountDisconnectResponse
- externalAccountGetTokenRequest
- externalAccountGetTokenResponse
- externalAccountInitiateRequest
- externalAccountInitiateResponse
- externalAccountLoginRequest
- externalAccountLoginResponse
- externalAccountValidateRequest
- externalAccountValidateResponse
- feedbackSendRequest
- feedbackSendResponse
- group
- groupCreateRequest
- groupCreateResponse
- groupGetGroupsRequest
- groupGetGroupsResponse
- groupGetUsersRequest
- groupGetUsersResponse
- groupInviteUsersRequest
- groupInviteUsersResponse
- groupLeaveRequest
- groupLeaveResponse
- groupRenameRequest
- groupRenameResponse
- groupSendMessageRequest
- groupSendMessageResponse
- messageSendRequest
- messageSendResponse
- msisdnVerifyCallRequest
- msisdnVerifyCallResponse
- msisdnVerifyCheckKeyRequest
- msisdnVerifyCheckKeyResponse
- msisdnVerifyCheckPinRequest
- msisdnVerifyCheckPinResponse
- msisdnVerifyCreateKeyRequest
- msisdnVerifyCreateKeyResponse
- msisdnVerifyRequest
- msisdnVerifyResponse
- msisdnVerifyStatusRequest
- msisdnVerifyStatusResponse
- proUserAddRequest
- proUserAddResponse
- proUserCheckRequest
- proUserCheckResponse
- registrationActivateMsisdnRequest
- registrationActivateMsisdnResponse
- registrationActivateRequest
- registrationActivateResponse
- registrationCheckMsisdnRequest
- registrationCheckMsisdnResponse
- registrationCreateKeyRequest
- registrationCreateKeyResponse
- registrationCreateRequest
- registrationCreateResponse
- remoteCallControlRequest
- remoteCallControlResponse
- remoteCallFailedRequest
- remoteCallFailedResponse
- remoteCallInitiateRequest
- remoteCallInitiateResponse
- remoteSmsCancelRequest
- remoteSmsCancelResponse
- remoteSmsFailedRequest
- remoteSmsFailedResponse
- remoteSmsResendRequest
- remoteSmsResendResponse
- remoteSmsSendAck
- remoteSmsSendRequest
- remoteSmsSendResponse
- remoteSmsSentRequest
- remoteSmsSentResponse
- request
- response
- shopCheckPaymentRequest
- shopCheckPaymentResponse
- shopGetPaymentMethodsRequest
- shopGetPaymentMethodsResponse
- shopPaymentMethod
- shopRedeemTokenRequest
- shopRedeemTokenResponse
- shopStartPaymentRequest
- shopStartPaymentResponse
- smsConnector
- smsConnectorCreateRequest
- smsConnectorCreateResponse
- smsConnectorGetConnectorsRequest
- smsConnectorGetConnectorsResponse
- smsSendAck
- smsSendRequest
- smsSendResponse
- smsSendSponsoredRequest
- smsSendSponsoredResponse
- typingFireEventRequest
- typingFireEventResponse
- userCall
- userCallCountUnreadRequest
- userCallCountUnreadResponse
- userCallDeleteAllRequest
- userCallDeleteAllResponse
- userCallDeleteListRequest
- userCallDeleteListResponse
- userCallGetCallsRequest
- userCallGetCallsResponse
- userCallInsertRequest
- userCallInsertResponse
- userCallReadAllRequest
- userCallReadAllResponse
- userCallSync
- userCallSyncAck
- userCallSyncRequest
- userCallSyncResponse
- userCallUpdateRequest
- userCallUpdateResponse
- userChangePasswordRequest
- userChangePasswordResponse
- userContact
- userContactGetA2aMsisdnsRequest
- userContactGetA2aMsisdnsResponse
- userContactGetContactsRequest
- userContactGetContactsResponse
- userContactOverride
- userContactOverrideUpdateRequest
- userContactOverrideUpdateResponse
- userContactSync
- userContactSyncAck
- userContactSyncRequest
- userContactSyncResponse
- userCreateRequest
- userCreateResponse
- userDeleteRequest
- userDeleteResponse
- userDeviceClientDeleteRequest
- userDeviceClientDeleteResponse
- userDeviceClientGetRequest
- userDeviceClientGetResponse
- userDeviceCreateRequest
- userDeviceCreateResponse
- userDeviceUpdateRequest
- userDeviceUpdateResponse
- userGetBalanceRequest
- userGetBalanceResponse
- userGetFeatureRequest
- userGetFeatureResponse
- userGetSettingRequest
- userGetSettingResponse
- userGetSmsRoutingRequest
- userGetSmsRoutingResponse
- userLoginRequest
- userLoginResponse
- userMessageConversation
- userMessageDeleteConversationListRequest
- userMessageDeleteConversationListResponse
- userMessageDeleteConversationRequest
- userMessageDeleteConversationResponse
- userMessageDeleteListRequest
- userMessageDeleteListResponse
- userMessageDeleteRequest
- userMessageDeleteResponse
- userMessageGetConversationsRequest
- userMessageGetConversationsResponse
- userMessageGetMessagesRequest
- userMessageGetMessagesResponse
- userMessageInsertRequest
- userMessageInsertResponse
- userMessageLockListRequest
- userMessageLockListResponse
- userMessageMessage
- userMessageReadConversationRequest
- userMessageReadConversationResponse
- userMessageSearchRequest
- userMessageSearchResponse
- userMessageSendRequest
- userMessageSendResponse
- userMessageSync
- userMessageSyncAck
- userMessageSyncRequest
- userMessageSyncResponse
- userMessageUnlockListRequest
- userMessageUnlockListResponse
- userMessageUpdateRequest
- userMessageUpdateResponse
- userResetPasswordRequest
- userResetPasswordResponse
- userSetSettingRequest
- userSetSettingResponse
- userSetSmsRoutingRequest
- userSetSmsRoutingResponse
- userSmsConnector
- userSmsConnectorExtended
- userSmsConnectorGetConnectorsExtendedRequest
- userSmsConnectorGetConnectorsExtendedResponse
- userSmsConnectorSetConnectorsRequest
- userSmsConnectorSetConnectorsResponse
- userSubscriptionActivateRequest
- userSubscriptionActivateResponse
- userSubscriptionDeactivateRequest
- userSubscriptionDeactivateResponse
- userSubscriptionGetRequest
- userSubscriptionGetResponse
- userSubscriptionLaunchRequest
- userSubscriptionLaunchResponse
- userSubscriptionLogRequest
- userSubscriptionLogResponse
- userVerifyMsisdnRequest
- userVerifyMsisdnResponse