Here is the list of parameters available for use with our SMS API.
WARNING : Parameters that are not mandatory, have a default value.
Authentication
The api-key and api-login must be added in the headers
| Name | Type | Description |
|---|---|---|
| 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”).’ |
| text | string | Message text (from 1 to 1224 characters). |
| 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",
}
] |
| type | string | Type of the campaign: [“sms_premium”,”sms_low_cost”] |
| purpose | string | Campaign purpose: [“alert”,”wholesale”] |
| with_replies | boolean | “True” for getting back recipient replies |
| 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 | (optionnel) (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_optimize_text | boolean | (optional) By transmitting this field with “false” value, your text will not be optimized by Octopush robot (your message could contain unicode characters, or useless spaces that could increase the number of needed SMS for each contact). |
Exclusive for SMS Vocal | ||
| voice_language | string | Langue de la voix [‘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’] |
| voice_gender | string | Genre de la voix [“male”, “female”] |
Exclusive to credit consultation | ||
| with_details | boolean | (optionnel) Add details aboout all your wallet packs. |
| product_name | string | (optionnel) (optional) Name of the product which you want to get your balance in (sms_low_cost, sms_premium, vocal_sms, hlr). You must also indicate country_code. |
Specifications Contact List Management | ||
Specifications Sub-accounts management | ||
SHA1 Request Codes
| Keys | Corresponding fields |
|---|---|
| T | sms_text |
| R | sms_recipients |
| M | sms_mode |
| Y | sms_type |
| S | sms_sender |
| D | sending_date |
| a | recipients_first_names |
| b | recipients_last_names |
| c | sms_fields_1 |
| d | sms_fields_2 |
| e | sms_fields_3 |
| W | with_replies |
| N | transactional |
| Q | request_id |