To send an SMS to the jtel Portal, an http(s) Request is made to the portal.
Receive SMS Call
Method
An http GET or POST request can be used.
GET requests have the advantage, you can test them directly from a browser.
The SMS Request is directed to an SMS connector associated with a particular client on the system.
These settings are configured by the system administrator.
URL
The following URL should be addressed:
http(s)://<portal_server>:<port>/SMSReceiver
For example:
https://jtelacd.example.com/SMSReceiver
Parameters
The following parameters are provided. Please ensure correct parameter encoding in the request.
| Parameter Name | Aliases (for various SMS providers and backwards compatibility) | Required | Comments |
|---|---|---|---|
| receiver | ziel system | Yes | The SMS receiver (number) to be addressed. |
| sender | absender | Yes | The sender's number. |
| message | data smstext | Yes | The message text. |
| keyword | Currently not used. | ||
| token | Sometimes | The authorization token for the SMS receive connector. This parameter is required when the "Require Token" option is set on the connector. |
Return http Status Codes
| Status Code | Meaning | Comments |
|---|---|---|
| 200 | OK | The SMS was created OK. Note, this does not indicate whether any routing of the SMS was successful or not. |
| 400 | Bad Request | The request does not contain at least the sender, receiver, and message tokens. |
| 401 | Unauthorized | The SMS receive connector requires authorization, but the token was not provided. |
| 404 | Not Found | The requested SMS receive connector was not found. |
| 500 | Internal Server Error | An error occurred when the SMS request was processed. In this case, check the web server logs for more details. |
| 502 | Bad Gateway | The SMS receive connector is not configured with an ACD group or routing application, or the client / reseller configuration is incorrect. |
Examples
Note, that the correct coding of the URL is important.
| Comments | URL |
|---|---|
| Without Authorization, Number Format E.164 without + | http://jtelacd.example.com/SMSReceiver?receiver=49123123&sender=49789789&message=This%20is%20a%20test%20message |
| Without Authorization, Number Format E.164 with + | http://jtelacd.example.com/SMSReceiver?receiver=%2B49123123&sender=%2B49789789&message=This%20is%20a%20test%20message |
| With Authorization, Number Format E.164 without + | http://jtelacd.example.com/SMSReceiver?receiver=49123123&sender=49789789&message=This%20is%20a%20test%20message&token=5760da99304185ca54edad4704379dd02e8d90419ab5e1fa5e066699bd9525de |
| With Authorization, Number Format E.164 with + | http://jtelacd.example.com/SMSReceiver?receiver=%2B49123123&sender=%2B49789789&message=This%20is%20a%20test%20message&token=5760da99304185ca54edad4704379dd02e8d90419ab5e1fa5e066699bd9525de |