Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Text Message Campaign

Create and manage SMS campaigns for your numbers

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/text-message/campaign

Gets a specific Text Message Campaign

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "caller_id_uuid" : "cb5ffaaa-274d-446c-aebf-01d27bb0a5e2",
            "campaign_name" : "My Support Campaign",
            "content_template" : "Thanks for calling our Support Team",
            "created_on" : "2022-06-01T09:30:00Z",
            "is_archived" : false,
            "is_draft" : true,
            "is_marketing" : false,
            "messages" : [
                {
                    "segment_count" : "1",
                    "uuid" : "6ebf7cd2-b973-4f19-b383-5df0ad77b5a0"
                }
            ],
            "recipients" : [
                {
                    "destination_cc" : "44",
                    "destination_number" : "7123456789",
                    "estimated_cost" : 0.05,
                    "from_phone_book" : false,
                    "segment_count" : 1,
                    "uuid" : "a58910c4-1cb0-464f-8167-a6dae59dd7e8"
                }
            ],
            "send_on" : "2022-06-01T10:00:00Z",
            "status" : "FINISHED",
            "total_cost" : 0.05,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

Chargeable *

POST/voip/text-message/campaign

Creates a new Text Message Campaign

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- caller_id_uuid
- String
- True
The UUID of the caller_id to use when sending the SMS
- campaign_name
- String
- True
The name of this Text Message Campaign
- is_draft
- Boolean
- True
Whether this Text Message Campaign is a draft
- message_content
- String
- True
The SMS content of this Text Message Campaign
- recipients
- Array of TextMessageRecipient
- True
The recipients to send this Text Message Campaign to. Must contain at least a phone_book_uuid, a phone_number, or a matching contact_uuid and phone_number pair
- send_on
- Date
- True
When to send this Text Message Campaign

TextMessageRecipient

- contact_uuid
- String
- False
The UUID of the contact to send the SMS to
- error_message
- String
- True
If this is not a valid number, why it failed validation
- estimated_cost
- BigDecimal
- True
The estimated cost for sending the SMS to this number
- is_valid
- boolean
- True
Whether this phone number is valid
- phone_book_uuid
- String
- False
The UUID of the phonebook the contact belongs to, if the contact_uuid is set
- phone_number
- String
- False
The phone number to send the SMS to
- segments
- int
- True
The number of segments for the SMS message to this number

JSON all-fields example:

{
    "caller_id_uuid" : "30f98f32-e000-45eb-ae93-9a8185f876a4",
    "campaign_name" : "My Support Campaign",
    "is_draft" : true,
    "message_content" : "Thanks for calling our Support Team",
    "recipients" : [
        {
            "phone_book_uuid" : "2cc78e89-3061-4dd0-846c-7ed6fd9bf68b"
        },
        {
            "contact_uuid" : "aa16b012-9057-40b1-9193-2357ad504039",
            "phone_number" : "+447123456780"
        },
        {
            "phone_number" : "+447123456781"
        },
        {
            "phone_number" : "+447123456782"
        }
    ],
    "send_on" : "2022-06-01T10:00:00Z"
}

Response Details

201 Response

{
    "result" : {
        "caller_id_uuid" : "cb5ffaaa-274d-446c-aebf-01d27bb0a5e2",
        "campaign_name" : "My Support Campaign",
        "content_template" : "Thanks for calling our Support Team",
        "created_on" : "2022-06-01T09:30:00Z",
        "is_archived" : false,
        "is_draft" : true,
        "is_marketing" : false,
        "messages" : [
            {
                "segment_count" : "1",
                "uuid" : "6ebf7cd2-b973-4f19-b383-5df0ad77b5a0"
            }
        ],
        "recipients" : [
            {
                "destination_cc" : "44",
                "destination_number" : "7123456789",
                "estimated_cost" : 0.05,
                "from_phone_book" : false,
                "segment_count" : 1,
                "uuid" : "a58910c4-1cb0-464f-8167-a6dae59dd7e8"
            }
        ],
        "send_on" : "2022-06-01T10:00:00Z",
        "status" : "FINISHED",
        "total_cost" : 0.05,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/voip/text-message/campaign/validate

Validates the specified Text Message Campaign and returns the expected cost

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- caller_id_uuid
- String
- True
The UUID of the caller_id to use when sending the SMS
- campaign_name
- String
- True
The name of this Text Message Campaign
- is_draft
- Boolean
- True
Whether this Text Message Campaign is a draft
- message_content
- String
- True
The SMS content of this Text Message Campaign
- recipients
- Array of TextMessageRecipient
- True
The recipients to send this Text Message Campaign to. Must contain at least a phone_book_uuid, a phone_number, or a matching contact_uuid and phone_number pair
- send_on
- Date
- True
When to send this Text Message Campaign

TextMessageRecipient

- contact_uuid
- String
- False
The UUID of the contact to send the SMS to
- error_message
- String
- True
If this is not a valid number, why it failed validation
- estimated_cost
- BigDecimal
- True
The estimated cost for sending the SMS to this number
- is_valid
- boolean
- True
Whether this phone number is valid
- phone_book_uuid
- String
- False
The UUID of the phonebook the contact belongs to, if the contact_uuid is set
- phone_number
- String
- False
The phone number to send the SMS to
- segments
- int
- True
The number of segments for the SMS message to this number

JSON all-fields example:

{
    "caller_id_uuid" : "30f98f32-e000-45eb-ae93-9a8185f876a4",
    "campaign_name" : "My Support Campaign",
    "is_draft" : true,
    "message_content" : "Thanks for calling our Support Team",
    "recipients" : [
        {
            "phone_book_uuid" : "2cc78e89-3061-4dd0-846c-7ed6fd9bf68b"
        },
        {
            "contact_uuid" : "aa16b012-9057-40b1-9193-2357ad504039",
            "phone_number" : "+447123456780"
        },
        {
            "phone_number" : "+447123456781"
        },
        {
            "phone_number" : "+447123456782"
        }
    ],
    "send_on" : "2022-06-01T10:00:00Z"
}

Response Details

201 Response

{
    "result" : {
        "recipients" : [
            {
                "contact_uuid" : "01cdedf9-2021-4a99-add3-4dbd86713604",
                "estimated_cost" : 0.05,
                "is_valid" : true,
                "phone_number" : "+447123456780",
                "segments" : 1
            },
            {
                "contact_uuid" : "9a179ecb-d1c8-460d-bfb5-85fc2f5d3cba",
                "estimated_cost" : 0.05,
                "is_valid" : true,
                "phone_book_uuid" : "e138d9de-59f3-4d0e-bf92-943af91d032c",
                "phone_number" : "+447123456781",
                "segments" : 1
            },
            {
                "estimated_cost" : 0.05,
                "is_valid" : true,
                "phone_number" : "+447123456783",
                "segments" : 1
            },
            {
                "error_message" : "Phone Number is not valid",
                "is_valid" : false,
                "phone_number" : "+4471234567XX",
                "segments" : 0
            }
        ],
        "total_estimated_cost" : 0.1
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

Chargeable *

PUT/voip/text-message/campaign/{uuid}

Updates the specified Text Message Campaign

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Text Message Campaign to be updated

PUT body

Name
Type
Required

- caller_id_uuid
- String
- True
The UUID of the caller_id to use when sending the SMS
- campaign_name
- String
- True
The name of this Text Message Campaign
- is_draft
- Boolean
- True
Whether this Text Message Campaign is a draft
- message_content
- String
- True
The SMS content of this Text Message Campaign
- recipients
- Array of TextMessageRecipient
- True
The recipients to send this Text Message Campaign to. Must contain at least a phone_book_uuid, a phone_number, or a matching contact_uuid and phone_number pair
- send_on
- Date
- True
When to send this Text Message Campaign

TextMessageRecipient

- contact_uuid
- String
- False
The UUID of the contact to send the SMS to
- error_message
- String
- True
If this is not a valid number, why it failed validation
- estimated_cost
- BigDecimal
- True
The estimated cost for sending the SMS to this number
- is_valid
- boolean
- True
Whether this phone number is valid
- phone_book_uuid
- String
- False
The UUID of the phonebook the contact belongs to, if the contact_uuid is set
- phone_number
- String
- False
The phone number to send the SMS to
- segments
- int
- True
The number of segments for the SMS message to this number

JSON all-fields example:

{
    "caller_id_uuid" : "30f98f32-e000-45eb-ae93-9a8185f876a4",
    "campaign_name" : "My Support Campaign",
    "is_draft" : true,
    "message_content" : "Thanks for calling our Support Team",
    "recipients" : [
        {
            "phone_book_uuid" : "2cc78e89-3061-4dd0-846c-7ed6fd9bf68b"
        },
        {
            "contact_uuid" : "aa16b012-9057-40b1-9193-2357ad504039",
            "phone_number" : "+447123456780"
        },
        {
            "phone_number" : "+447123456781"
        },
        {
            "phone_number" : "+447123456782"
        }
    ],
    "send_on" : "2022-06-01T10:00:00Z"
}

Response Details

200 Response

{
    "result" : {
        "caller_id_uuid" : "cb5ffaaa-274d-446c-aebf-01d27bb0a5e2",
        "campaign_name" : "My Support Campaign",
        "content_template" : "Thanks for calling our Support Team",
        "created_on" : "2022-06-01T09:30:00Z",
        "is_archived" : false,
        "is_draft" : true,
        "is_marketing" : false,
        "messages" : [
            {
                "segment_count" : "1",
                "uuid" : "6ebf7cd2-b973-4f19-b383-5df0ad77b5a0"
            }
        ],
        "recipients" : [
            {
                "destination_cc" : "44",
                "destination_number" : "7123456789",
                "estimated_cost" : 0.05,
                "from_phone_book" : false,
                "segment_count" : 1,
                "uuid" : "a58910c4-1cb0-464f-8167-a6dae59dd7e8"
            }
        ],
        "send_on" : "2022-06-01T10:00:00Z",
        "status" : "FINISHED",
        "total_cost" : 0.05,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

Chargeable *

PUT/voip/text-message/campaign/{uuid}/confirm

Moves the specified draft Text Message Campaign from draft to confirmed, and queues it for sending

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Text Message Campaign to be confirmed and sent

Response Details

201 Response

{
    "result" : {
        "caller_id_uuid" : "cb5ffaaa-274d-446c-aebf-01d27bb0a5e2",
        "campaign_name" : "My Support Campaign",
        "content_template" : "Thanks for calling our Support Team",
        "created_on" : "2022-06-01T09:30:00Z",
        "is_archived" : false,
        "is_draft" : true,
        "is_marketing" : false,
        "messages" : [
            {
                "segment_count" : "1",
                "uuid" : "6ebf7cd2-b973-4f19-b383-5df0ad77b5a0"
            }
        ],
        "recipients" : [
            {
                "destination_cc" : "44",
                "destination_number" : "7123456789",
                "estimated_cost" : 0.05,
                "from_phone_book" : false,
                "segment_count" : 1,
                "uuid" : "a58910c4-1cb0-464f-8167-a6dae59dd7e8"
            }
        ],
        "send_on" : "2022-06-01T10:00:00Z",
        "status" : "FINISHED",
        "total_cost" : 0.05,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

DELETE/voip/text-message/campaign/{uuid}

Deletes the specified Text Message Campaign
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Text Message Campaign to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```