Versions Compared

Old Version 16

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

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 NameAliases (for various SMS providers and backwards compatibility)RequiredComments
receiver

ziel

system

YesThe SMS receiver (number) to be addressed.
senderabsenderYesThe sender's number.
message

data

smstext

YesThe 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 CodeMeaningComments
200OKThe SMS was created OK. Note, this does not indicate whether any routing of the SMS was successful or not.
400Bad Request

The request does not contain at least the sender, receiver, and message tokens.

401UnauthorizedThe SMS receive connector requires authorization, but the token was not provided.
404Not FoundThe requested SMS receive connector was not found.
500Internal Server ErrorAn error occurred when the SMS request was processed. In this case, check the web server logs for more details.
502Bad GatewayThe 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.

CommentsURL
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



...

Sv translation
languagefr

API du connecteur de réception de SMS / API du récepteur de SMS

Recevoir un appel par SMS

Méthode

Une requête http GET ou POST peut être utilisée. 

Les requêtes GET ont l'avantage de pouvoir être testées directement à partir d'un navigateur.

La requête SMS est dirigée vers un connecteur SMS associé à un client particulier sur le système.

Ces paramètres sont configurés par l'administrateur du système.

URL

L'URL suivante doit être adressée :

http(s)://<portal_server>:<port>/SMSReceiver

Par exemple:

https://jtelacd.example.com/SMSReceiver

Paramètres

Les paramètres suivants sont fournis. Veuillez vous assurer que l'encodage des paramètres est correct dans la demande.

Nom du paramètreAlias (pour divers fournisseurs de SMS et compatibilité ascendante)RequiseCommentaires
récepteur

cible

système

OuiLe récepteur (numéro) de SMS à adresser.
expéditeurexpéditeurOuiNuméro de l'expéditeur
message

données

smstext

OuiLe texte du message.
mots clés

Non utilisé actuellement.
jeton

Parfois

Le jeton d'autorisation pour le connecteur de réception de SMS. Ce paramètre est requis lorsque l'option "Require Token" est activée sur le connecteur.

Return http Status Codes

Statut CodeSignificationCommentaires
200OKLe SMS a été créé OK. Notez que cela n'indique pas si le routage du SMS a réussi ou non.
400Mauvaise requête

La demande ne contient pas au moins les jetons expéditeur, récepteur, et messages.

401Non autoriséLe connecteur de réception de SMS nécessite une autorisation, mais le jeton n'a pas été fourni.
404Non trouvéLe connecteur de réception de SMS demandé n'a pas été trouvé.
500Erreur de serveur interneUne erreur s'est produite lors du traitement de la demande par SMS. Dans ce cas, consultez les journaux du serveur web pour plus de détails.
502Mauvaise passerelleLe connecteur de réception de SMS n'est pas configuré avec un groupe ACD ou une application de routage, ou la configuration client / revendeur est incorrecte.

Exemples

Notez que le codage correct de l'URL est important.

CommentairesURL
Sans autorisation, Format des numéros E.164 sans +http://jtelacd.example.com/SMSReceiver?receiver=49123123&sender=49789789&message=This%20is%20a%20test%20message
Sans autorisation, Format des numéros E.164 avec +http://jtelacd.example.com/SMSReceiver?receiver=%2B49123123&sender=%2B49789789&message=This%20is%20a%20test%20message
Avec autorisation, Format des numéros E.164 sans +http://jtelacd.example.com/SMSReceiver?receiver=49123123&sender=49789789&message=This%20is%20a%20test%20message&token=5760da99304185ca54edad4704379dd02e8d90419ab5e1fa5e066699bd9525de
Avec autorisation, Format des numéros E.164 avec +http://jtelacd.example.com/SMSReceiver?receiver=%2B49123123&sender=%2B49789789&message=This%20is%20a%20test%20message&token=5760da99304185ca54edad4704379dd02e8d90419ab5e1fa5e066699bd9525de