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
RESTPOSThttps://[Your URL]/api/2.0/production/sms/batch


Required Parameters
PropertyTypeDescriptionDefaultRequiredRead Only
category_namestringThe category name is used when fetching data for reports.emptyYesN/A
Mobile numberstringThe mobile phone number to send the message to.emptyYesN/A
SMS message textstringThe SMS message to be sent.emptyYesN/A
Optional Parameters

You may include any of these optional parameters when adding a contact:

PropertyTypeDescriptionDefaultRequiredRead Only
custom_idintegerCustom identifier used to match the sent message in the reporting dataemptynoN/A


arrayA failure will return an array with phone numbers that failed, as well as the failure reason.
arrayA 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 
                  ["+27721234567", "hello Mike", "custom_id_1"], 
                  ["+27721234568", "hello Bob", "custom_id_2"]
         "category_name":"new category"
Example Response
                         "error":{ "mobile_number":["validation.mobile_number"]},