Opérations disponibles
Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
client-ref2client reference up to 40 characters, the reference will be present in every message status
smsThe channel the message is going to.
sms447700900000The phone number of the message recipient in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
smsThe channel the message is coming from
sms447700900001The Vonage Virtual number the message is originating from in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
textThe content type of the message
textHello From Vonage!Limited to 1000 characters. The Messages API automatically detects unicode characters when sending SMS and sends the message as a unicode SMS. For more information on how concatenation and encoding please visit: developer.vonage.com/messaging/sms/guides/concatenation-and-encoding.
Exemple Demande
{
"client_ref": "client-ref2",
"to": {
"type": "sms",
"number": "447700900000"
},
"from": {
"type": "sms",
"number": "447700900001"
},
"message": {
"content": {
"type": "text",
"text": "Hello From Vonage!"
}
}
}{
"client_ref": "client-ref2",
"to": {
"type": "sms",
"number": "447700900000"
},
"from": {
"type": "sms",
"number": "447700900001"
},
"message": {
"content": {
"type": "text",
"text": "Hello From Vonage!"
}
}
}aaaaaaaa-bbbb-cccc-dddd-0123456789abThe UUID of the message.
Exemple Réponse
{
"message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}aaaaaaaa-bbbb-cccc-dddd-0123456789abThe UUID of the message.
smsThe type of message that you want to send.
smsviber_service_msgmessengerwhatsappmms1500123456789012345Messenger: The ID of the message recipient. This value should be the from.id value you received in the inbound messenger event.
150447700900000SMS, Viber, WhatsApp or MMS: The phone number of the message recipient in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
smsThe type of message that you want to send.
smsviber_service_msgmessengerwhatsappmms1500123456789012345Your ID for the platform that you are sending from.
Messenger: This value should be the to.id value you received in the inbound messenger event.
Viber: This is your Service Message ID given to you by your Vonage Account Manager. To find out more please visit vonage.com.
150447700900000SMS: The phone number of the message recipient in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.
WhatsApp: This is your WhatsApp Business Number given to you by your Vonage Account Manager. To find out more please visit vonage.com.
MMS: US shortcode
2020-01-01T14:00:00.000ZThe datetime of when the event occurred.
deliveredThe status of the message. The read message status is available for messenger, whatsapp and viber.
submitteddeliveredreadrejectedundeliverable1300The error code. See our errors list for a list of possible errors
Not part of the provider networkText describing the error. See our errors list for a list of possible errors
EURThe charge currency in ISO 4217 format.
EUR0.0333The charge amount as a stringified number.
my-personal-referenceThe client's reference.
Exemple Charge utile
{
"message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"to": {
"type": "sms",
"id": "0123456789012345",
"number": "447700900000"
},
"from": {
"type": "sms",
"id": "0123456789012345",
"number": "447700900000"
},
"timestamp": "2020-01-01T14:00:00.000Z",
"status": "delivered",
"error": {
"code": 1300,
"reason": "Not part of the provider network"
},
"usage": {
"currency": "EUR",
"price": "0.0333"
},
"client_ref": "my-personal-reference"
}Crochets Web
Les webhooks sont une extension d'une API, mais au lieu que votre code demande des données, l'API vous envoie des données. Les données arrivent dans une requête web à votre application.
Pour en savoir plus sur les webhooks, consultez notre site documentation sur les webhooks.
Cette API peut envoyer l'un des webhooks décrits ci-dessous à l'URL que vous avez configurée. Vous devez répondre avec une réponse HTTP 200 ou 204, sinon les demandes seront relancées.
Opérations disponibles
aaaaaaaa-bbbb-cccc-dddd-0123456789abThe UUID of the message.
2020-01-01T14:00:00.000ZThe datetime of when the event occurred.
smsThe channel the message is going to.
sms447700900000The Vonage Virtual number the sms is being sent to in the E.164 format.
smsThe channel the message is coming from
sms447700900001The phone number the message is originating from in the E.164 format.
textThe content type of the message
textHello From Vonage!The UTF-8 encoded text of the inbound message.
2The number of inbound SMS messages concatenated together to comprise this message. SMS messages are 160 characters, if an inbound message exceeds that size they are concatenated together to forma single message. This number indicates how many messages formed this webhook.
EURThe charge currency in ISO 4217 format.
EUR0.0333The charge amount as a stringified number.
Exemple Charge utile
{
"message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"timestamp": "2020-01-01T14:00:00.000Z",
"to": {
"type": "sms",
"number": "447700900000"
},
"from": {
"type": "sms",
"number": "447700900001"
},
"message": {
"content": {
"type": "text",
"text": "Hello From Vonage!"
},
"sms": {
"num_messages": "2"
}
},
"usage": {
"currency": "EUR",
"price": "0.0333"
}
}Erreurs
Voici une liste non exhaustive des codes d'erreur susceptibles de se produire lors de l'utilisation de cette API.
Ces codes s'ajoutent à ceux de notre site codes d'erreur génériques.
| Code | Informations |
|---|---|
| 1000 | Throttled - You have exceeded the submission capacity allowed on this account. Please wait and retry |
| 1010 | Missing params - Your request is incomplete and missing some mandatory parameters. |
| 1020 | Invalid params - The value of one or more parameters is invalid. |
| 1021 | Invalid tag - The tag value is invalid. |
| 1022 | Invalid template - Invalid template or template parameters |
| 1030 | Internal error - There was an error processing your request in the Platform. |
| 1040 | Invalid message - The Platform was unable to process your request. For example, due to an unrecognised prefix for the phone number. |
| 1050 | Number barred - The number you are trying to submit to is blacklisted and may not receive messages. |
| 1060 | Partner account barred - The |
| 1070 | Partner quota exceeded - Your pre-paid account does not have sufficient credit to process this message. |
| 1080 | Account not enabled for REST - This account is not provisioned for REST submission, you should use SMPP on the SMS API. |
| 1090 | Message too long - The length of |
| 1100 | Communication Failed - Message was not submitted because there was a communication failure. |
| 1120 | Illegal Sender Address - rejected - Due to local regulations, the |
| 1130 | Invalid TTL - The value of |
| 1140 | Facility not allowed - Your request makes use of a facility that is not enabled on your account. |
| 1150 | Invalid Message class - The value of |
| 1160 | Non White-listed Destination - The phone number you set in to is not in your pre-approved destination list. To send messages to this phone number, add it using Dashboard. |
| 1170 | Invalid or Missing Msisdn Param - The phone number you supplied in the to parameter of your request was either missing or invalid. |
| 1180 | Absent Subscriber Temporary - This message was not delivered because to was temporarily unavailable. For example, the handset used for to was out of coverage or switched off. This is a temporary failure, retry later for a positive result. |
| 1190 | Absent Subscriber Permanent - |
| 1200 | Portability Error - There is an issue after the user has changed carrier for to. If the user wants to receive messages from you, they need to contact their carrier directly. |
| 1210 | Anti-Spam Rejection - Carriers often apply restrictions that block messages following different criteria. For example on SenderID or message content. |
| 1220 | Handset Busy - The handset associated with to was not available when this message was sent. If status is rejected, this is a temporary failure; retry later for a positive result. If status is submitted, this message has is in the retry scheme and will be resent until it expires in 24-48 hours. |
| 1230 | Network Error - A network failure while sending your message. This is a temporary failure, retry later for a positive result. |
| 1240 | Illegal Number - You tried to send a message to a blacklisted phone number. That is, the user has already sent a STOP opt-out message and no longer wishes to receive messages from you. |
| 1241 | Too many send requests - Too many send requests to phone numbers. |
| 1250 | Unroutable - The chosen route to send your message is not available. This is because the phone number is either currently on an unsupported network or on a pre-paid or reseller account that could not receive a message sent by from. To resolve this issue either email support or create a helpdesk ticket here. |
| 1260 | Destination unreachable - The message could not be delivered to the phone number. If using Viber Business Messages your account might not be enabled for this country. |
| 1270 | Subscriber Age Restriction - The carrier blocked this message because the content is not suitable for to based on age restrictions. |
| 1280 | Number Blocked by Carrier - The carrier blocked this message. This could be due to several reasons. For example, to's plan does not include SMS or the account is suspended. |
| 1290 | Pre-Paid - Insufficient funds - to’s pre-paid account does not have enough credit to receive the message. |
| 1300 | Not part of the provider network - The number or ID is not a user in the provider network. |
| 1310 | Not suitable device - The user's device can't receive the message. |
| 1320 | Message already sent - The message was already sent. |
| 1330 | Unknown - An unknown error was received from the carrier who tried to send this this message. Depending on the carrier, that to is unknown. When you see this error, and status is rejected, always check if to in your request was valid. |
| 1331 | Provider error - The provider is not responding or unable to process the request. Please try sending your message in a few minutes time. |
| 1340 | Outside of the allowed window - This message is sent outside of allowed response window. |
| 1350 | Phone matching fee not paid - Requires phone matching access fee to be paid by the Facebook Page. |
| 1360 | TTL was activated - TTL was activated, no callbacks and no charge will be issued. |
| 1370 | Expired access Token - Please reauthenticate your Facebook Page with Vonage. |
| 1380 | Invalid resource - Please check that the URL your provided to your resrouce is accesible and valid. |
| 1381 | Resource size is too large - Please try sending a smaller media file. |
| 1382 | Resource type is invalid - Please check that the file you are trying to send is valid. |