API-SMS Documentation: Schedule Voice SMS Sending

POST

https://api.octopush.com/v1/public/voice-campaign/send

Encodage : UTF-8

Authentification

Your “api-key” and “api-login” identifiers must be added in the headers.

Definition

Allows you to send a deferred voice SMS indicating your sending date in ISO format.

Special parameters

Name	Type	Description
text	string	Message text (from 1 to 1224 characters non unicode).
recipients	array	List of Contact objects array of objects: [ { "phone_number": "+111222233334444", "param1": "Alex", "param2": null, "param3": null, "param4": null, "param5": null, }, ..., { "phone_number": "+2222333334444555", "param1": "John", } ]
sender	string	Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9).
send_at	string	‘When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”).’
purpose	string	Campaign purpose: (transactional/alert or marketing) : [“alert”,”wholesale”]
voice_gender	string	Voice gender [‘male’, ‘female’]
voice_language	string	Voice Language [‘en-US’, ‘en-GB’, ‘el-GR’, ‘pl-PL’, ‘hu-HU’, ‘sv-SE’, ‘de-DE’, ‘es-ES’, ‘es-LA’, ‘fr-FR’, ‘it-IT’, ‘pt-BR’, ‘ru-RU’]
simulation_mode	boolean	(optional) If this value is “true”, your request will be simulated, and you will receive a fake result. Only some minimal validations will be executed.
request_id	string	(optional) To avoid sending same request multiple times, setup an request ID. In case the duplication will be detected, a validation error will be returned. A request_id will expire after 24 hours.
`auto_remove_blacklisted_numbers`	boolean	(optional) By transmitting this field with “true” value, the blacklisted numbers will be automatically removed from your list of numbers. This service will add a charge of 0.01€ per request.

Curl Example

curl -X POST \ 
'https://api.octopush.com/v1/public/voice-campaign/send' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
   "recipients": [
      {
         "phone_number": "+336000123",
         "param1": "Alex"
      }
   ],
   "text": "You have one VoiceSMS.",
   "purpose": "alert",
   "sender": "12345",
   "send_at": "2018-10-03T07:42:39-07:00",
   "voice_gender": "female",
   "voice_language": "en-GB"
}'

curl -X POST 'https://api.octopush.com/v1/public/voice-campaign/send' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"recipients": [{"phone_number": "+336000123", "param1": "Alex"}], "text": "You have one VoiceSMS.", "purpose": "alert", "sender": "12345", "send_at": "2018-10-03T07:42:39-07:00", "voice_gender": "female", "voice_language": "en-GB"}'

JSON Server Response

Success : 201 CREATED

{
  "ticket_number": "voice_5f44ebf9e47b7",
  "number_of_contacts": 1,
  "total_cost": 0.05,
  "estimated_duration": 30,
  "residual_credit": 149.95
}

Failure : 400 Bad Request

{
   "code": 400,
   "message": "Payload validation error.",
   "errors":
   {
      "voice_language":
      {
         "code": 442,
         "message": "Voice language not supported."
      }
   }
}