appmixer.ringring.core.MessageApiSmsRequest_Post
Send SMS
1.0.0
Public
| Field | Type | Description |
|---|---|---|
| No properties defined | ||
| Field | Type | Description |
|---|---|---|
| Api Key | text | The application key. |
| To | text | The phone number of the end user formatted following the E.164 recommendation of ITU-T (For example 32460123456 for a Belgian mobile number). You can enter up to 1000 numbers separated with , (comma) Example: 32485123456 |
| Message | textarea | The message. The content should be shorter than 1530 characters. |
| Message Encoding | select | This parameter overrides the encoding defined in the application. Values 'Text', 'Auto' or 'Unicode' are valid, other entries are ignored. |
| Reference | text | This is a reference you can use to trace your SMS internally. This one will be communicated if you receive a reply on your SMS through the Incoming API. Example: 3f1a06c6-5c3f-4e55-9b01-a29dbb0e8bcf |
| From | text | If you have different shortcodes assigned to your application Example: 8686 |
| Sender Id | text | Some countries allow to change the SenderId. |
| Time Scheduled | date-time | The datetime (yyyy/MM/dd hh:mm:ss) at which you wish to send the SMS. If this falls outside of the Timewindow configuration, the request will be refused. |
| Time Validity | date-time | Expiration datetime (yyyy/MM/dd hh:mm:ss) of message |
| Replace If Present | text | This parameter allows to replace the content of a previously sent SMS that is still pending. The authorized values are between 1 and 7. This makes it possible to replace the content of up to the 7th SMS delivered in the past from the same number to the same recipient. Example: 1 |
| Field | Type | Description |
|---|---|---|
| Reference | - | |
| Messages | - | |
| Message Encoding | - | |
| Number Of Parts | - | |
| Number Of Chars | - | |
| Result Code | - | |
| Result Description | - |