Spec - SMS
Table Of Contents
- Get SMS Campaigns
- Add SMS Campaign
- Edit SMS Campaign
- Delete SMS Campaign
- Get CRM Activities SMSes
- Add SMS Response
- Edit SMS Response
- Delete SMS Response
Get SMS Campaigns
Retrieves the list of SMS campaigns.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
Output
Success or failure. List of SMS campaigns.
- CampaignID
- CampaignName
- GroupID
- GroupName
- FromPhoneNumber
- SendDatetime
- Message
- MMSimageURL
- NumRecipients
Example Request
<GetSMSCampaignsRequest/>
Example Request (Shared Access)
<GetSMSCampaignsRequest account_id="12345" group_id="1"/>
Example Response
<GetSMSCampaignsResponse>
<Result>Success</Result>
<SMSCampaigns>
<SMSCampaign>
<CampaignID>8</CampaignID>
<CampaignName>Campaign 8</CampaignName>
<GroupID>11</GroupID>
<GroupName>Active Subscribers</GroupName>
<FromPhoneNumber>+13302365946</FromPhoneNumber>
<SendDatetime>2022-05-03T07:14:59-0700</SendDatetime>
<Message>Verifying.</Message>
<MMSimageURL></MMSimageURL>
<NumRecipients>1</NumRecipients>
</SMSCampaign>
<SMSCampaign>
<CampaignID>9</CampaignID>
<CampaignName>Campaign 9</CampaignName>
<GroupID>11</GroupID>
<GroupName>Active Subscribers</GroupName>
<FromPhoneNumber>+13302365946</FromPhoneNumber>
<SendDatetime>2022-05-05T08:52:42-0700</SendDatetime>
<Message>Verify Model::Job 2</Message>
<MMSimageURL></MMSimageURL>
<NumRecipients>1</NumRecipients>
</SMSCampaign>
</SMSCampaigns>
</GetSMSCampaignsResponse>
Add SMS Campaign
Create a new SMS campaign.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- CampaignName (required)
- GroupID (required)
- FromPhoneNumber (required, in international format, eg. +12125551234)
- SendDatetime (required, in ISO 8601 format, eg. 2025-01-06T16:41:09-07:00)
- Message (required)
- MMSimageURL (optional)
- RecipientContactIDs (required, list of contact IDs)
Output
Success or failure. New SMS campaign ID.
- CampaignID
Example Request
<AddSMSCampaignRequest>
<CampaignName>Verify Campaign Name</CampaignName>
<GroupID>4</GroupID>
<FromPhoneNumber>+61488461116</FromPhoneNumber>
<SendDatetime>2025-01-03T12:34:56Z</SendDatetime>
<Message>The quick brown fox jumps over the lazy dog.</Message>
<MMSimageURL>https://test.com/test.jpg</MMSimageURL>
<RecipientContactIDs>
<RecipientContactID>123</RecipientContactID>
<RecipientContactID>623</RecipientContactID>
</RecipientContactIDs>
</AddSMSCampaignRequest>
Example Request (Shared Access)
<AddSMSCampaignRequest account_id="12345" group_id="1">
<CampaignName>Verify Campaign Name</CampaignName>
<GroupID>4</GroupID>
<FromPhoneNumber>+61488461116</FromPhoneNumber>
<SendDatetime>2025-01-03T12:34:56Z</SendDatetime>
<Message>The quick brown fox jumps over the lazy dog.</Message>
<MMSimageURL>https://test.com/test.jpg</MMSimageURL>
<RecipientContactIDs>
<RecipientContactID>123</RecipientContactID>
<RecipientContactID>623</RecipientContactID>
</RecipientContactIDs>
</AddSMSCampaignRequest>
Example Response
<AddSMSCampaignResponse>
<Result>Success</Result>
<CampaignID>11</CampaignID>
</AddSMSCampaignResponse>
Edit SMS Campaign
Update an existing SMS campaign.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- campaign_id (required)
- CampaignName (optional)
- FromPhoneNumber (optional, in international format, eg. +12125551234)
- SendDatetime (optional, in ISO 8601 format, eg. 2025-01-06T16:41:09-07:00)
- Message (optional)
- MMSimageURL (optional)
Output
Success or failure. The SMS campaign ID.
- CampaignID
Example Request
<EditSMSCampaignRequest campaign_id="11">
<CampaignName>Edit Verify Name</CampaignName>
<FromPhoneNumber>+15155551212</FromPhoneNumber>
<SendDatetime>2025-01-03T12:34:57Z</SendDatetime>
<Message>the quick brown fox jumps over the lazy dog.</Message>
<MMSimageURL>https://edit.com/test.jpg</MMSimageURL>
</EditSMSCampaignRequest>
Example Request (Shared Access)
<EditSMSCampaignRequest campaign_id="11" account_id="12345" group_id="1">
<CampaignName>Edit Verify Name</CampaignName>
<FromPhoneNumber>+15155551212</FromPhoneNumber>
<SendDatetime>2025-01-03T12:34:57Z</SendDatetime>
<Message>the quick brown fox jumps over the lazy dog.</Message>
<MMSimageURL>https://edit.com/test.jpg</MMSimageURL>
</EditSMSCampaignRequest>
Example Response
<EditSMSCampaignResponse>
<Result>Success</Result>
<CampaignID>11</CampaignID>
</EditSMSCampaignResponse>
Delete SMS Campaign
Remove an existing SMS campaign.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- campaign_id (required)
Output
Success or failure. The SMS campaign ID.
- CampaignID
Example Request
<DeleteSMSCampaignRequest campaign_id="10"/>
Example Request (Shared Access)
<DeleteSMSCampaignRequest campaign_id="10" account_id="12345" group_id="1"/>
Example Response
<DeleteSMSCampaignResponse>
<Result>Success</Result>
<CampaignID>11</CampaignID>
</DeleteSMSCampaignResponse>
Get CRM Activities SMSes
Retrieves the list of SMS campaigns and responses for a contact.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- contact_id (required)
Output
Success or failure. List of SMS campaigns and responses.
- CampaignID
- CampaignName
- CampaignType
- SendDatetime
- SendDatetimeUTC
- FromPhoneNumber
- Message
- MMSimageURL
- ResponseID
- Reponse
- ResponseDatetime
- ResponseDatetimeUTC
Example Request
<GetCRMActivitiesSMSesRequest contact_id="623"/>
Example Request (Shared Access)
<GetCRMActivitiesSMSesRequest contact_id="623" account_id="12345" group_id="1"/>
Example Response
<GetCRMActivitiesSMSesResponse>
<Result>Success</Result>
<SMSes>
<SMS>
<CampaignID>12</CampaignID>
<CampaignName>Verify Campaign Name</CampaignName>
<CampaignType>MMS</CampaignType>
<SendDatetime>20250103043456</SendDatetime>
<SendDatetimeUTC>2025-01-03T12:34:00Z</SendDatetimeUTC>
<FromPhoneNumber>+61488461116</FromPhoneNumber>
<Message>The quick brown fox jumps over the lazy dog.</Message>
<MMSimageURL>https://test.com/test.jpg</MMSimageURL>
<Response></Response>
<ResponseID></ResponseID>
<ResponseDatetime></ResponseDatetime>
<ResponseDatetimeUTC></ResponseDatetimeUTC>
</SMS>
<SMS>
<CampaignID>12</CampaignID>
<CampaignName>Verify Campaign Name</CampaignName>
<CampaignType>SMS</CampaignType>
<SendDatetime></SendDatetime>
<SendDatetimeUTC></SendDatetimeUTC>
<FromPhoneNumber></FromPhoneNumber>
<Message></Message>
<MMSimageURL></MMSimageURL>
<Response>The quickbrown fox jumps over the lazy dog.</Response>
<ResponseID>4</ResponseID>
<ResponseDatetime>20250103043454</ResponseDatetime>
<ResponseDatetimeUTC>2025-01-03T12:34:00Z</ResponseDatetimeUTC>
</SMS>
</SMSes>
</GetCRMActivitiesSMSesResponse>
Add SMS Response
Create a new SMS response.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- campaign_id (required)
- ContactID (required)
- FromNumber (required, in international format, eg. +12125551234)
- Response (optional)
- ResponseDatetime (required, in ISO 8601 format, eg. 2025-01-06T16:41:09-07:00)
Output
Success or failure. New SMS response ID.
- ResponseID
Example Request
<AddSMSResponseRequest campaign_id="12">
<ContactID>623</ContactID>
<FromNumber>+15155551214</FromNumber>
<Response>The quickbrown fox jumps over the lazy dog.</Response>
<ResponseDatetime>2025-01-03T12:34:54Z</ResponseDatetime>
</AddSMSResponseRequest>
Example Request (Shared Access)
<AddSMSResponseRequest campaign_id="12" account_id="12345" group_id="1">
<ContactID>623</ContactID>
<FromNumber>+15155551214</FromNumber>
<Response>The quickbrown fox jumps over the lazy dog.</Response>
<ResponseDatetime>2025-01-03T12:34:54Z</ResponseDatetime>
</AddSMSResponseRequest>
Example Response
<AddSMSResponseResponse>
<Result>Success</Result>
<ResponseID>3</ResponseID>
</AddSMSResponseResponse>
Edit SMS Response
Update an existing SMS response.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- campaign_id (required)
- response_id (required)
- ContactID (optional)
- FromNumber (optional, in international format, eg. +12125551234)
- Response (optional)
- ResponseDatetime (optional, in ISO 8601 format, eg. 2025-01-06T16:41:09-07:00)
Output
Success or failure. The SMS response ID.
- ResponseID
Example Request
<EditSMSResponseRequest campaign_id="12" response_id="3">
<ContactID>623</ContactID>
<FromNumber>+15155551212</FromNumber>
<Response>Thequickbrown fox jumps over the lazy dog.</Response>
<ResponseDatetime>2025-01-03T12:34:56Z</ResponseDatetime>
</EditSMSResponseRequest>
Example Request (Shared Access)
<EditSMSResponseRequest campaign_id="12" response_id="3" account_id="12345" group_id="1">
<ContactID>623</ContactID>
<FromNumber>+15155551212</FromNumber>
<Response>Thequickbrown fox jumps over the lazy dog.</Response>
<ResponseDatetime>2025-01-03T12:34:56Z</ResponseDatetime>
</EditSMSResponseRequest>
Example Response
<EditSMSResponseResponse>
<Result>Success</Result>
<ResponseID>3</ResponseID>
</EditSMSResponseResponse>
Delete SMS Response
Remove an existing SMS response.
Input
- account_id (required for shared access user)
- group_id (required for shared access user)
- campaign_id (required)
- response_id (required)
Output
Success or failure. The SMS response ID.
- ResponseID
Example Request
<DeleteSMSResponseRequest campaign_id="12" response_id="3"/>
Example Request (Shared Access)
<DeleteSMSResponseRequest campaign_id="12" response_id="3" account_id="12345" group_id="1"/>
Example Response
<DeleteSMSResponseResponse>
<Result>Success</Result>
<ResponseID>3</ResponseID>
</DeleteSMSResponseResponse>