Overview
This request allows the user to send multiple SMS messages within a single API call.
The Method
| Type (REST / XML_RPC) | Request (POST / GET / Call) | Method |
|---|---|---|
| REST | POST | https://[Your URL]/api/2.0/production/sms/batch |
Your URL is the address of your install.
Parameters
Required Parameters
| Property | Type | Description | Default | Required | Read Only |
|---|---|---|---|---|---|
| category_name | string | The category name is used when fetching data for reports. | empty | Yes | N/A |
| Mobile number | string | The mobile phone number to send the message to. | empty | Yes | N/A |
| SMS message text | string | The SMS message to be sent. | empty | Yes | N/A |
Optional Parameters
You may include any of these optional parameters when adding a contact:
| Property | Type | Description | Default | Required | Read Only |
|---|---|---|---|---|---|
| custom_id | integer | Custom identifier used to match the sent message in the reporting data | empty | no | N/A |
Responses
| Type | Description |
|---|---|
| array | A failure will return an array with phone numbers that failed, as well as the failure reason. |
| array | A successful request will return an empty array. |
Code Samples
Example Request
POST /api/2.0/ production/sms/batch HTTP/1.1 Host: https://[Your URL] Authorization: Basic YWRtaW5pc3RyYXRvcjp2bE1lTGk2UlVJR21SQzNvaWRMZXBsc2J5RU5NRkY3Yl85OTk= Content-Type: application/json