Skip to content

Instantly share code, notes, and snippets.

@jaimejim

jaimejim/vonage-oas.json

Created January 29, 2024 13:37
Show Gist options
  • Save jaimejim/3069e78b44eaa53bea82bcca2df8b2e6 to your computer and use it in GitHub Desktop.
Save jaimejim/3069e78b44eaa53bea82bcca2df8b2e6 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
vonage-oas.json
{
"openapi": "3.0.1",
"info": {
"version": "1.6.0",
"title": "Messages API",
"x-metaTitle": "Vonage Olympus API (v1.0) Reference | Vonage API Documentation",
"x-metaDescription": "Find quick answers to questions about the Vonage Olympus API (v1.0) in this reference guide. Learn more in Vonage's API documentation.",
"description": "The Messages API consolidates and normalises exchanges across all messaging channels. It allows you to use a single API to interact with our various channels such as SMS, MMS, WhatsApp, Viber and Facebook Messenger. See [this note](https://developer.vonage.com/en/messages/technical-details#authentication) on authentication.",
"contact": {
"name": "Nexmo DevRel",
"email": "devrel@nexmo.com",
"url": "https://developer.nexmo.com/"
}
},
"servers": [
{
"url": "https://api.nexmo.com"
}
],
"paths": {
"/v1/messages": {
"post": {
"security": [
{
"bearerAuth": []
},
{
"basicAuth": []
}
],
"description": "Send a Message",
"summary": "Send a message to the given channel.",
"operationId": "SendMessage",
"requestBody": {
"description": "Send a Message.",
"required": true,
"x-show-example-request": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "SMS",
"x-tab-id": "SMS",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"properties": {
"text": {
"description": "The text of message to send; limited to 1000 characters. Unless unless `text` or `unicode` has\nbeen explicitly set as the value for `sms.encoding_type`, the Messages API automatically\ndetects whether unicode characters are present in `text` and sends the message as appropriate\nas either a text or unicode SMS. For more information on concatenation and encoding\nplease visit: [developer.nexmo.com/messaging/sms/guides/concatenation-and-encoding](https://developer.vonage.com/messaging/sms/guides/concatenation-and-encoding).\n"
}
}
},
{
"$ref": "#/components/schemas/channelOptionsSms"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
}
]
},
{
"title": "MMS",
"x-tab-id": "MMS",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Image"
},
{
"properties": {
"image": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the image attachment.\n\nSupports `.jpg`, `.jpeg`, `.png` and `.gif`.\n",
"example": "https://example.com/image.jpg"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the image.",
"minLength": 1,
"maxLength": 2000,
"example": "Additional text to accompany the image."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMms"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/vCard"
},
{
"properties": {
"vcard": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the vCard attachment.\n\nSupports `.vcf` only.\n",
"example": "https://example.com/contact.vcf"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the vCard.",
"minLength": 1,
"maxLength": 2000,
"example": "Additional text to accompany the vCard."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMms"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Audio"
},
{
"properties": {
"message_type": {
"type": "string",
"enum": [
"audio"
],
"example": "audio",
"description": "The type of message to send. You must provide `audio` in this field.\n\nFor best device and network support .mp3 is recommended. Not supported for US short codes.\n"
},
"audio": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the audio attachment.\n",
"example": "https://example.com/audio.mp3"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the audio file.",
"minLength": 1,
"maxLength": 2000,
"example": "Additional text to accompany the audio file."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMms"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Video"
},
{
"properties": {
"message_type": {
"type": "string",
"enum": [
"video"
],
"example": "video",
"description": "The type of message to send. You must provide `video` in this field.\n\nFor best device and network support .mp4 is recommended. Not supported for US short codes.\n"
},
"video": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the video attachment.\n",
"example": "https://example.com/video.mp4"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the video file.",
"minLength": 1,
"maxLength": 2000,
"example": "Additional text to accompany the video file."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMms"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
}
]
},
{
"title": "WhatsApp",
"x-tab-id": "WhatsApp",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"properties": {
"text": {
"description": "The text of message to send; limited to 4096 characters, including unicode.\n"
}
}
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Image"
},
{
"properties": {
"image": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the image attachment.\n\nSupports `.jpg`, `.jpeg`, and `.png`.\n",
"example": "https://example.com/image.jpg"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the image.",
"minLength": 1,
"maxLength": 3000,
"example": "Additional text to accompany the image."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Audio"
},
{
"properties": {
"audio": {
"required": [
"url"
],
"properties": {
"url": {
"description": "The URL of the audio attachment.\n\nSupports `.aac`, `.m4a`, `.amr`, `.mp3` and `.opus`.\n",
"minLength": 10,
"maxLength": 2000
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Video"
},
{
"properties": {
"video": {
"required": [
"url"
],
"properties": {
"url": {
"description": "The URL of the video attachment.\n\nSupports `.mp4` and `.3gpp`. Note, only `H.264` video codec and `AAC` audio codec is supported.\n"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the file.",
"example": "Additional text."
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/File"
},
{
"properties": {
"file": {
"required": [
"url"
],
"properties": {
"url": {
"description": "The URL of the file attachment.\n\nSupports supports a wide range of attachments including `.zip`, `.csv` and `.pdf`.\n"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the file.",
"example": "Additional text."
},
"name": {
"type": "string",
"description": "Optional parameter that specifies the name of the file being sent. If not included, the value for `caption`\nwill be used as the file name. If neither `name` or `caption` are included, the file name will be parsed\nfrom the `url`.\n",
"example": "file.pdf"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"required": [
"message_type",
"whatsapp"
]
},
{
"$ref": "#/components/schemas/Template"
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
},
{
"properties": {
"whatsapp": {
"type": "object",
"required": [
"locale"
],
"properties": {
"policy": {
"type": "string",
"example": "deterministic",
"enum": [
"deterministic"
],
"description": "Policy for resolving what language template to use. As of right now the only valid choice is `deterministic`."
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) language of the template. See [the WhatsApp documentation](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages-) for supported languages."
}
}
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Sticker"
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"required": [
"message_type"
]
},
{
"$ref": "#/components/schemas/Custom"
},
{
"$ref": "#/components/schemas/channelOptionsWhatsapp"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
}
]
},
{
"title": "Messenger",
"x-tab-id": "Messenger",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"properties": {
"text": {
"description": "The text of message to send; limited to 640 characters, including unicode.\n"
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMessenger"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Image"
},
{
"properties": {
"image": {
"properties": {
"url": {
"type": "string",
"description": "The URL of the image attachment.\n\nSupports `.jpg`, `.jpeg`, `.png` and `.gif`.\n",
"example": "https://example.com/image.jpg"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMessenger"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Audio"
},
{
"properties": {
"audio": {
"properties": {
"url": {
"description": "The URL of the audio attachment.\n\nOnly supports `.mp3` files\n",
"minLength": 10,
"maxLength": 2000
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMessenger"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Video"
},
{
"properties": {
"video": {
"properties": {
"url": {
"description": "The URL of the video attachment.\n\nSupports `.mp4` files. Note, only `H.264` video codec and `AAC` audio codec is supported.\n"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMessenger"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/File"
},
{
"properties": {
"file": {
"properties": {
"url": {
"description": "The URL of the file attachment.\n\nSupports a wide range of attachments including `.zip`, `.csv` and `.pdf`.\n"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsMessenger"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
}
]
},
{
"title": "Viber",
"x-tab-id": "Viber",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"properties": {
"text": {
"description": "The text of message to send; limited to 1000 characters, including unicode.\n"
}
}
},
{
"$ref": "#/components/schemas/channelOptionsViberWithButton"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Image"
},
{
"properties": {
"image": {
"properties": {
"url": {
"type": "string",
"description": "The URL of the image attachment.\n\nSupports `.jpg`, `.jpeg`, and `.png`.\n",
"example": "https://example.com/image.jpg"
},
"caption": {
"type": "string",
"description": "A caption to accompany the image. Required if the message includes an action button.",
"example": "Check out this new promotion"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsViberWithButton"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/Video"
},
{
"properties": {
"video": {
"properties": {
"url": {
"type": "string",
"description": "The URL of the video attachment.",
"example": "https://example.com/image.jpg"
},
"caption": {
"type": "string",
"description": "Text caption to accompany message.",
"example": "Check out this new video"
},
"thumb_url": {
"type": "string",
"maxLength": 1000,
"description": "URL to an image file for a thumbnail preview of the video.",
"example": "https://example.com/file1.jpg"
}
},
"required": [
"url",
"duration",
"file_size",
"thumb_url"
]
}
}
},
{
"$ref": "#/components/schemas/channelOptionsViberVideo"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/File"
},
{
"properties": {
"file": {
"description": "An object containing details of the file to be sent. Note: allowed file types are `.doc,` `.docx`, `.rtf`, `.dot`, `.dotx`, `.odt`, `.odf`, `.fodt`, `.txt`, `.info`, `.pdf`, `.xps`, `.pdax`, `.eps`, `.xls`, `.xlsx`, `.ods`, `.fods`, `.csv`, `.xlsm`, `.xltx`. Maximum file size is 200MB",
"properties": {
"url": {
"type": "string",
"description": "The URL for the file attachment *or* the path for the location of the file attachement. If `name` is included, can just be the path. If `name` is not included, must include the filename and extension.",
"example": "https://example.com/files/"
},
"name": {
"type": "string",
"maxLength": 25,
"description": "The name and extension of the file.",
"example": "example.pdf"
}
}
}
}
},
{
"$ref": "#/components/schemas/channelOptionsViber"
},
{
"$ref": "#/components/schemas/outboundMessageCommon"
}
]
}
]
}
]
}
}
}
},
"responses": {
"202": {
"description": "Accepted.",
"content": {
"application/json": {
"schema": {
"type": "object",
"oneOf": [
{
"description": "SMS",
"x-tab-id": "SMS",
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
}
}
},
{
"description": "MMS",
"x-tab-id": "MMS",
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
}
}
},
{
"description": "WhatsApp",
"x-tab-id": "WhatsApp",
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
}
}
},
{
"description": "Messenger",
"x-tab-id": "Messenger",
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
}
}
},
{
"description": "Viber",
"x-tab-id": "Viber",
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
}
}
}
]
}
}
}
},
"401": {
"description": "Authentication failure",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorUnauthorizedMissingCredentials"
},
{
"$ref": "#/components/schemas/ErrorUnauthorizedInvalidApplication"
}
]
}
}
}
},
"402": {
"description": "Payment Required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorPaymentRequired"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorInvalidJson"
},
{
"$ref": "#/components/schemas/ErrorChannel"
},
{
"$ref": "#/components/schemas/ErrorChannelParams"
},
{
"$ref": "#/components/schemas/ErrorSender"
},
{
"$ref": "#/components/schemas/ErrorRecipient"
},
{
"$ref": "#/components/schemas/ErrorMessageType"
},
{
"$ref": "#/components/schemas/ErrorMessageParams"
},
{
"$ref": "#/components/schemas/ErrorClientReference"
}
]
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorThrottled"
}
}
}
},
"500": {
"description": "Internal error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorInternal"
}
}
}
}
},
"callbacks": {
"message-status": {
"{$request.body#/callback}": {
"post": {
"summary": "Message Status",
"operationId": "message-status",
"x-example-path": "/webhooks/message-status",
"description": "Webhooks provide information about events happening to the message such as whether it has been sent, delivered or rejected by the provider.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/messageStatusSMS"
},
{
"$ref": "#/components/schemas/messageStatusMMS"
},
{
"$ref": "#/components/schemas/messageStatusWhatsApp"
},
{
"$ref": "#/components/schemas/messageStatusMessenger"
},
{
"$ref": "#/components/schemas/messageStatusViber"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Your server returns this code if it accepts the callback."
}
}
}
}
}
}
}
}
},
"x-webhooks": {
"inbound-message": {
"{$request.body#/callback}": {
"post": {
"summary": "Inbound Message",
"operationId": "inbound-message",
"x-example-path": "/webhooks/inbound-message",
"description": "An inbound message from a customer to you.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/inboundMessageSMS"
},
{
"title": "MMS",
"x-tab-id": "MMS",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/inboundMessageMMS"
},
{
"$ref": "#/components/schemas/Text"
},
{
"properties": {
"text": {
"type": "string",
"description": "The text in the inbound message.",
"maxLength": 640,
"example": "This is sample text."
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundMessageMMS"
},
{
"$ref": "#/components/schemas/Image"
},
{
"properties": {
"image": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the image attachment.\n\nSupports `.jpg`, `.jpeg`, `.png` and `.gif`.\n",
"example": "https://example.com/image.jpg"
},
"caption": {
"type": "string",
"description": "Additional text to accompany the image.",
"minLength": 1,
"maxLength": 2000,
"example": "Additional text to accompany the image."
}
}
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundMessageMMS"
},
{
"$ref": "#/components/schemas/vCard"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundMessageMMS"
},
{
"$ref": "#/components/schemas/Audio"
},
{
"properties": {
"audio": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Publicly accessible URL of the audio attachment.",
"minLength": 10,
"maxLength": 2000
}
}
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundMessageMMS"
},
{
"$ref": "#/components/schemas/Video"
},
{
"properties": {
"video": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Publicly accessible URL of the video attachment."
}
}
}
}
}
]
}
]
},
{
"title": "WhatsApp",
"x-tab-id": "WhatsApp",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/File"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Audio"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
},
{
"properties": {
"audio": {
"required": [
"url"
],
"properties": {
"url": {
"minLength": 10,
"maxLength": 2000
}
}
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Location"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Reply"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Order"
},
{
"$ref": "#/components/schemas/WhatsAppNodeOrder"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/InboundSticker"
},
{
"$ref": "#/components/schemas/WhatsAppNodeReferral"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/inboundWhatsAppMessageCommon"
},
{
"$ref": "#/components/schemas/Unsupported"
}
]
}
]
},
{
"title": "Messenger",
"x-tab-id": "Messenger",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/Text"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/Image"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/Video"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/File"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/Audio"
},
{
"properties": {
"audio": {
"required": [
"url"
],
"properties": {
"url": {
"minLength": 10,
"maxLength": 2000
}
}
}
}
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundMessengerMessageCommon"
},
{
"$ref": "#/components/schemas/Unsupported"
}
]
}
]
},
{
"title": "Viber",
"x-tab-id": "Viber",
"oneOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/InboundViberMessageCommon"
},
{
"$ref": "#/components/schemas/Text"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundViberMessageCommon"
},
{
"$ref": "#/components/schemas/Image"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundViberMessageCommon"
},
{
"$ref": "#/components/schemas/Video"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/InboundViberMessageCommon"
},
{
"$ref": "#/components/schemas/File"
}
]
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "Your server returns this code if it accepts the callback."
}
}
}
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"basicAuth": {
"type": "http",
"scheme": "basic"
}
},
"schemas": {
"TemplateParameters": {
"type": "array",
"description": "The parameters are an array of strings, with the first string being used for `{{1}}` in the template, with the second being `{{2}}` etc. Only required if the template specified by `name` contains parameters.",
"example": [
"Verification",
"2526",
"5"
],
"items": {
"type": "string"
}
},
"Image": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Image",
"x-tab-id": "Image",
"type": "object",
"required": [
"image"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"image"
],
"example": "image",
"description": "The type of message to send. You must provide `image` in this field"
},
"image": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"format": "url",
"description": "The publicly accessible URL of the image attachment. The image file is available for 48 hours after it is created. Supported types are .jpg, .jpeg, and .png",
"example": "https://example.com/image.jpg",
"type": "string"
}
}
}
}
}
]
},
"Audio": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Audio",
"x-tab-id": "Audio",
"type": "object",
"required": [
"audio"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"audio"
],
"example": "audio",
"description": "The type of message to send. You must provide `audio` in this field"
},
"audio": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "url",
"example": "https://example.com/audio.mp3"
}
}
}
}
}
]
},
"Video": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Video",
"x-tab-id": "Video",
"type": "object",
"required": [
"video"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"video"
],
"example": "video",
"description": "The type of message to send. You must provide `video` in this field"
},
"video": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Publicly accessible URL of the video attachment. Supports file types .mp4 and .3gpp\n> Note: Only supports video codec H.264 and audio codec AAC\n",
"format": "url",
"example": "https://example.com/video.mp4"
}
}
}
}
}
]
},
"vCard": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "vCard",
"x-tab-id": "vCard",
"type": "object",
"required": [
"vcard"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"vcard"
],
"example": "vcard",
"description": "The type of message to send. You must provide `vcard` in this field"
},
"vcard": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"format": "url",
"description": "The publicly accessible URL of the vCard attachment. Supported types are .vcf only",
"example": "https://example.com/conatact.vcf",
"type": "string"
}
}
}
}
}
]
},
"Unsupported": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Unsupported",
"x-tab-id": "Unsupported",
"type": "object",
"required": [
"message_type"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"unsupported"
],
"example": "unsupported",
"description": "The type of message to send. Will be `unsupported` if the type of message received from user is not supported by the channel."
}
}
}
]
},
"File": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "File",
"x-tab-id": "File",
"type": "object",
"required": [
"file"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"file"
],
"example": "file",
"description": "The type of message to send. You must provide `file` in this field"
},
"file": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"example": "https://example.com/file.pdf"
}
}
}
}
}
]
},
"Template": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Template",
"x-tab-id": "Template",
"type": "object",
"required": [
"template"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"template"
],
"example": "template",
"description": "The type of message to send. You must provide `template` in this field"
},
"template": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "9b6b4fcb_da19_4a26_8fe8_78074a91b584:verify",
"description": "The name of the template. For WhatsApp use your WhatsApp namespace (available via Facebook Business Manager), followed by a colon : and the name of the template to use."
},
"parameters": {
"$ref": "#/components/schemas/TemplateParameters"
}
}
}
}
}
]
},
"Custom": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Custom",
"x-tab-id": "Custom",
"type": "object",
"properties": {
"message_type": {
"type": "string",
"enum": [
"custom"
],
"example": "custom",
"description": "The type of message to send. You must provide `custom` in this field"
},
"custom": {
"type": "object",
"description": "A custom payload, which is passed directly to WhatsApp for certain features such as templates and interactive messages. The schema of a custom object can vary widely. [Read more about Custom Objects](https://developer.vonage.com/messages/concepts/custom-objects).",
"additionalProperties": true
}
}
}
]
},
"Reply": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Reply",
"x-tab-id": "Reply",
"type": "object",
"required": [
"reply"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"reply"
],
"example": "reply",
"description": "The type of message to send. You must provide `custom` in this field."
},
"reply": {
"required": [
"id",
"title"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "row1",
"description": "An identifier to help identify the exact interactive message response."
},
"title": {
"type": "string",
"example": "9am",
"description": "The title displayed on the interactive option chosen."
},
"description": {
"type": "string",
"example": "Select 9am appointmaent time",
"description": "A description that may be added to the interactive options presented (available only on interactive lists)."
}
}
}
}
}
]
},
"Location": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Location",
"x-tab-id": "Location",
"type": "object",
"required": [
"location"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"location"
],
"example": "location",
"description": "The type of message to send. You must provide `location` in this field"
},
"location": {
"required": [
"lat",
"long"
],
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 40.34772,
"description": "Latitude of the location."
},
"long": {
"type": "number",
"example": -74.18847,
"description": "Longitude of the location."
},
"name": {
"type": "string",
"example": "Vonage",
"description": "Name of the location."
},
"address": {
"type": "string",
"example": "23 Main St, Holmdel, NJ 07733, USA",
"description": "Address of the location. Only displayed if `name` is present."
}
}
}
}
}
]
},
"Order": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Order",
"x-tab-id": "Order",
"type": "object",
"required": [
"order"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"order"
],
"example": "order",
"description": "The type of message to send."
},
"order": {
"required": [
"catalog_id",
"product_items"
],
"type": "object",
"properties": {
"catalog_id": {
"type": "string",
"example": "2806150799683508",
"description": "The ID of the catalog containing the products in this order."
},
"product_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_retailer_id": {
"type": "string",
"example": "pk1v7rudbg",
"description": "The ID of the specific product being ordered."
},
"quantity": {
"type": "string",
"example": "1",
"description": "The quantity ordered for this specific item."
},
"item_price": {
"type": "string",
"example": "9.99",
"description": "The unit price for this specific item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "The currency code representing the currency for this specific item."
}
}
}
}
}
}
}
}
]
},
"Sticker": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Sticker",
"x-tab-id": "Sticker",
"required": [
"sticker"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"sticker"
],
"example": "sticker",
"description": "The type of message to send. You must provide `sticker` in this field"
},
"sticker": {
"type": "object",
"description": "Object with details of the sticker to send. Must contain either a URL or an ID, but not both.\nSee the [documentation](/messages/guides/whatsapp-stickers) for more\ninformation on sending stickers.\n",
"oneOf": [
{
"$ref": "#/components/schemas/StickerWithURL"
},
{
"$ref": "#/components/schemas/StickerWithID"
}
]
}
}
}
]
},
"StickerWithURL": {
"description": "Sticker with URL",
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"format": "url",
"description": "The publicly accessible URL of the sticker image. Supported types are: .webp. See the\n[documentation](/messages/guides/whatsapp-stickers) for more\ninformation on sending stickers.\n",
"example": "https://example.com/image.webp",
"type": "string"
}
}
},
"StickerWithID": {
"description": "Sticker with ID",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"description": "The id of the sticker in relation to a specific WhatsApp deployment. See the\n[documentation](/messages/guides/whatsapp-stickers) for more\ninformation on sending stickers.\n",
"example": "aabb7a31-1d1f-4755-a574-2971d831cd5b",
"type": "string"
}
}
},
"InboundSticker": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Sticker",
"x-tab-id": "Sticker",
"required": [
"sticker"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"sticker"
],
"example": "sticker",
"description": "The type of message."
},
"sticker": {
"type": "object",
"description": "Object with a URL to access the sticker that was sent.",
"required": [
"url"
],
"properties": {
"url": {
"format": "url",
"description": "The URL of the sticker image on Vonage's media servers.",
"example": "https://api-us.nexmo.com/v3/media/1b456509-974c-458b-aafa-45fc48a4d976",
"type": "string"
}
}
}
}
}
]
},
"Text": {
"allOf": [
{
"$ref": "#/components/schemas/baseMessageType"
},
{
"title": "Text",
"x-tab-id": "Text",
"description": "The text of message to send.",
"required": [
"text"
],
"properties": {
"message_type": {
"type": "string",
"enum": [
"text"
],
"example": "text",
"description": "The type of message to send. You must provide `text` in this field"
},
"text": {
"type": "string",
"example": "Nexmo Verification code: 12345.<br />Valid for 10 minutes."
}
}
}
]
},
"ErrorChannel": {
"description": "Unsupported channel",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1100"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Unsupported channel"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The specified channel is not supported."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorChannelParams": {
"description": "Invalid channel parameters",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1110"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid channel parameters"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The value of one or more parameters is invalid."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
},
"invalid_parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of invalid parameter",
"example": "messenger.category"
},
"reason": {
"type": "string",
"description": "Reason of failure",
"example": "Must be one of `response`, `update` or `message_tag`."
}
}
}
}
}
},
"ErrorSender": {
"description": "Invalid sender",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1120"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid sender"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The `from` parameter is invalid for the given channel."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorRecipient": {
"description": "Invalid recipient",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#110"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid recipient"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The `to` parameter is invalid for the given channel."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorMessageType": {
"description": "Invalid message type",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1140"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid message type"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The `to` parameter is invalid for the given channel."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorMessageParams": {
"description": "Invalid message parameters",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1150"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid params"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The value of one or more parameters is invalid."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
},
"invalid_parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of invalid parameter",
"example": "image.url"
},
"reason": {
"type": "string",
"description": "Reason of failure",
"example": "is required."
}
}
}
}
}
},
"ErrorClientReference": {
"description": "Invalid client reference",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1060"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Invalid client reference"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "The client reference can be a string of up to 40 characters."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorPaymentRequired": {
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/#low-balance"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Low balance"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "This request could not be performed due to your account balance being low."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorThrottled": {
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1000"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Rate Limit Hit"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "Please wait, then retry your request"
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorInternal": {
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1000"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "Internal error"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "There was an error processing your request in the Platform."
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorInvalidJson": {
"description": "Invalid JSON",
"type": "object",
"required": [
"type",
"title",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors#invalid-json"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "The request body did not contain valid JSON"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries"
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorUnauthorizedInvalidApplication": {
"description": "Invalid Application Type",
"type": "object",
"required": [
"type",
"title",
"details",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/#unprovisioned"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "The crendentials provided do not have access to the requested product"
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "Check your API key is correct and has been whitelisted"
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"ErrorUnauthorizedMissingCredentials": {
"description": "Missing or Invalid Credentials",
"type": "object",
"required": [
"type",
"title",
"details",
"instance"
],
"properties": {
"type": {
"type": "string",
"description": "Link to error / remediation options",
"example": "https://developer.nexmo.com/api-errors/#unathorized"
},
"title": {
"type": "string",
"description": "Generic error message",
"example": "You did not provide correct credentials."
},
"detail": {
"type": "string",
"description": "Additional information about the error",
"example": "Check that you're using the correct credentials, and that your account has this feature enabled"
},
"instance": {
"type": "string",
"description": "Internal Trace ID",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
}
},
"MessageUuid": {
"type": "string",
"example": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"description": "The UUID of the message"
},
"ToNumber": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"example": "447700900000",
"description": "The phone number of the message **recipient** in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.\n"
},
"FromNumber": {
"type": "string",
"example": "447700900001",
"description": "The phone number of the message **sender** in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000. For SMS in certain localities alpha-numeric sender id's will work as well, see [Global Messaging](https://developer.nexmo.com/messaging/sms/guides/country-specific-features#country-specific-features) for more details\n"
},
"ToId": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "0123456789",
"description": "The ID of the message recipient\n"
},
"FromId": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "9876543210",
"description": "The ID of the message sender\n"
},
"outboundMessageCommon": {
"type": "object",
"properties": {
"client_ref": {
"type": "string",
"description": "Client reference of up to 100 characters. The reference will be present in every message status."
},
"webhook_url": {
"type": "string",
"description": "Specifies the URL to which Status Webhook messages will be sent *for this particular message*.\nOver-rides account-level and application-level Status Webhook url settings on a per-message basis.\n",
"example": "https://example.com/status"
},
"webhook_version": {
"type": "string",
"description": "Specifies which version of the Messages API will be used to send Status Webhook messages *for this particular message*.\nFor example, if `v0.1` is set, then the JSON body of Status Webhook messages for this message will be sent in Messages v0.1 format.\nOver-rides account-level and application-level API version settings on a per-message basis.\n",
"example": "v1",
"enum": [
"v0.1",
"v1"
]
}
}
},
"baseMessageType": {
"type": "object",
"required": [
"to",
"from",
"message_type",
"channel"
]
},
"channelOptionsSms": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"channel": {
"type": "string",
"description": "The channel to send to. You must provide `sms` in this field",
"example": "sms",
"enum": [
"sms"
]
},
"ttl": {
"type": "integer",
"description": "The duration in milliseconds the delivery of an SMS will be attempted. By default Vonage attempts delivery\nfor 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours.\nWe recommend this value should be kept at its default or at least 30 minutes.\n",
"example": 900000
},
"sms": {
"type": "object",
"description": "An object of optional settings for the SMS message.",
"properties": {
"encoding_type": {
"type": "string",
"description": "The encoding type to use for the message. If set to either `text` or `unicode` the specified type will be used.\nIf set to `auto` (the default), the Messages API will automatically set the type based on the content of `text`;\ni.e. if unicode characters are detected in `text`, then the message will be encoded as unicode, and otherwise as text.\n",
"example": "text",
"enum": [
"text",
"unicode",
"auto"
]
},
"content_id": {
"description": "A string parameter that satisfies regulatory requirements when sending an SMS to specific countries.\nFor more information please refer to the [Country-Specific Outbound SMS Features](https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions)\"\n",
"type": "string",
"example": "1107457532145798767"
},
"entity_id": {
"description": "A string parameter that satisfies regulatory requirements when sending an SMS to specific countries.\nFor more information please refer to the [Country-Specific Outbound SMS Features](https://api.support.vonage.com/hc/en-us/sections/200622473-Country-Specific-Features-and-Restrictions)\n",
"type": "string",
"example": "1101456324675322134"
}
}
}
}
},
"channelOptionsMms": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"channel": {
"type": "string",
"description": "The channel to send to. You must provide `mms` in this field",
"example": "mms",
"enum": [
"mms"
]
}
}
},
"channelOptionsMessenger": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToId"
},
"from": {
"$ref": "#/components/schemas/FromId"
},
"channel": {
"description": "The channel to send to. You must provide `messenger` in this field",
"type": "string",
"example": "messenger",
"enum": [
"messenger"
]
},
"messenger": {
"type": "object",
"properties": {
"category": {
"type": "string",
"example": "response",
"description": "The use of different category tags enables the business to send messages for different use cases. For Facebook Messenger they need to comply with their [Messaging Types policy](https://developers.facebook.com/docs/messenger-platform/send-messages#messaging_types). Vonage maps our `category` to their `messaging_type`. If `message_tag` is used, then an additional `tag` for that type is mandatory. By default Vonage sends the `response` category to Facebook Messenger.",
"enum": [
"response",
"update",
"message_tag"
]
},
"tag": {
"description": "A tag describing the type and relevance of the 1:1 communication between your app and the end user. A full list of available tags is available [here](https://developers.facebook.com/docs/messenger-platform/send-messages/message-tags)",
"example": "CONFIRMED_EVENT_UPDATE",
"type": "string"
}
}
}
}
},
"channelOptionsViber": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromId"
},
"channel": {
"description": "The channel to send to. You must provide `viber_service` in this field",
"type": "string",
"example": "viber_service",
"enum": [
"viber_service"
]
},
"viber_service": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The use of different category tags enables the business to send messages for different use cases. For Viber Business Messages the first message sent from a business to a user must be personal, informative & a targeted message - not promotional. By default Vonage sends the `transaction` category to Viber Business Messages.",
"enum": [
"transaction",
"promotion"
]
},
"ttl": {
"minimum": 30,
"maximum": 259200,
"description": "Set the time-to-live of message to be delivered in seconds. i.e. if the message is not delivered in 600 seconds then delete the message.",
"example": 600,
"type": "integer"
},
"type": {
"description": "Viber-specific type definition. To use \"template\", please contact your Vonage Account Manager to setup your templates. To find out more please visit the [product page](https://www.vonage.com/communications-apis/messages/)",
"type": "string"
}
}
}
}
},
"channelOptionsViberVideo": {
"type": "object",
"required": [
"viber_service"
],
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromId"
},
"channel": {
"description": "The channel to send to. You must provide `viber_service` in this field",
"type": "string",
"example": "viber_service",
"enum": [
"viber_service"
]
},
"viber_service": {
"type": "object",
"required": [
"duration",
"file_size"
],
"properties": {
"category": {
"type": "string",
"description": "The use of different category tags enables the business to send messages for different use cases. For Viber Business Messages the first message sent from a business to a user must be personal, informative & a targeted message - not promotional. By default Vonage sends the `transaction` category to Viber Business Messages.",
"enum": [
"transaction",
"promotion"
]
},
"duration": {
"type": "string",
"minimum": 1,
"maximum": 600,
"description": "The duration of the video in seconds.",
"example": "123"
},
"file_size": {
"type": "string",
"minimum": 1,
"maximum": 200,
"description": "The file size of the video in MB.",
"example": "1"
},
"ttl": {
"minimum": 30,
"maximum": 259200,
"description": "Set the time-to-live of message to be delivered in seconds. i.e. if the message is not delivered in 600 seconds then delete the message.",
"example": 600,
"type": "integer"
},
"type": {
"description": "Viber-specific type definition. To use \"template\", please contact your Vonage Account Manager to setup your templates. To find out more please visit the [product page](https://www.vonage.com/communications-apis/messages/)",
"type": "string"
}
}
}
}
},
"channelOptionsViberWithButton": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromId"
},
"channel": {
"description": "The channel to send to. You must provide `viber_service` in this field",
"type": "string",
"example": "viber_service",
"enum": [
"viber_service"
]
},
"viber_service": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "The use of different category tags enables the business to send messages for different use cases. For Viber Business Messages the first message sent from a business to a user must be personal, informative & a targeted message - not promotional. By default Vonage sends the `transaction` category to Viber Business Messages.",
"enum": [
"transaction",
"promotion"
]
},
"ttl": {
"minimum": 30,
"maximum": 259200,
"description": "Set the time-to-live of message to be delivered in seconds. i.e. if the message is not delivered in 600 seconds then delete the message.",
"example": 600,
"type": "integer"
},
"type": {
"description": "Viber-specific type definition. To use \"template\", please contact your Vonage Account Manager to setup your templates. To find out more please visit the [product page](https://www.vonage.com/communications-apis/messages/)",
"type": "string"
},
"action": {
"description": "Node for Viber action buttons.",
"type": "object",
"required": [
"url",
"text"
],
"properties": {
"url": {
"description": "A URL which is requested when the action button is clicked.",
"type": "string",
"example": "https://example.com/page1.html"
},
"text": {
"description": "Text which is rendered on the action button.",
"type": "string",
"maxLength": 30,
"example": "Find out more"
}
}
}
}
}
}
},
"channelOptionsWhatsapp": {
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"channel": {
"description": "The channel to send to. You must provide `whatsapp` in this field",
"type": "string",
"example": "whatsapp",
"enum": [
"whatsapp"
]
},
"context": {
"description": "An optional context used for quoting/replying to a specific meesage in a conversation. When used, the WhatsApp UI will display the new message \nalong with a contextual bubble that displays the quoted/replied to message's content.\n",
"type": "object",
"required": [
"message_uuid"
],
"properties": {
"message_uuid": {
"description": "The UUID of the message being replied to/quoted.",
"type": "string",
"example": "a1b2c3d4a1b2c3d4"
}
}
}
}
},
"messageStatusBase": {
"type": "object",
"properties": {
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"timestamp": {
"type": "string",
"description": "The datetime of when the event occurred, in `ISO 8601` format.",
"example": "2020-01-01T14:00:00.000Z"
},
"status": {
"type": "string",
"description": "The status of the message.",
"example": "submitted",
"enum": [
"submitted",
"delivered",
"rejected",
"undeliverable"
]
},
"error": {
"type": "object",
"description": "If the message encountered a problem a descriptive error will be supplied in this object.",
"properties": {
"type": {
"type": "string",
"format": "url",
"description": "The type of error encountered, follow URL for more details",
"example": "https://developer.nexmo.com/api-errors/messages-olympus#1000"
},
"title": {
"type": "string",
"example": 1000,
"description": "The error code encountered when sending the message. See [our errors list](https://developer.nexmo.com/api-errors/messages-olympus) for a list of possible errors"
},
"detail": {
"type": "string",
"example": "Throttled - You have exceeded the submission capacity allowed on this account. Please wait and retry",
"description": "Text describing the error. See [our errors list](https://developer.nexmo.com/api-errors/messages-olympus) for a list of possible errors"
},
"instance": {
"type": "string",
"example": "bf0ca0bf927b3b52e3cb03217e1a1ddf",
"description": "The record id of this error's occurrence."
}
}
},
"usage": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "EUR",
"description": "The charge currency in ISO 4217 format.",
"enum": [
"EUR"
]
},
"price": {
"type": "string",
"example": "0.0333",
"description": "The charge amount as a stringified number."
}
}
},
"client_ref": {
"type": "string",
"description": "Client reference of up to 100 characters. The reference will be present in every message status."
}
},
"required": [
"message_uuid",
"channel",
"to",
"from",
"timestamp",
"status"
]
},
"messageStatusSMS": {
"allOf": [
{
"$ref": "#/components/schemas/messageStatusBase"
},
{
"title": "SMS",
"x-tab-id": "SMS",
"description": "SMS",
"properties": {
"channel": {
"type": "string",
"description": "The channel sending to.",
"example": "sms",
"enum": [
"sms"
]
},
"destination": {
"$ref": "#/components/schemas/Destination"
},
"sms": {
"description": "Channel specific metadata for SMS",
"type": "object",
"properties": {
"count_total": {
"type": "string",
"example": "2",
"description": "The number of SMS messages concatenated together to comprise the submitted message. SMS messages are 160 characters, if a submitted message exceeds that size it is sent as multiple SMS messages. This number indicates how many SMS messages are required."
}
}
}
}
}
]
},
"messageStatusMMS": {
"allOf": [
{
"$ref": "#/components/schemas/messageStatusBase"
},
{
"title": "MMS",
"x-tab-id": "MMS",
"description": "MMS",
"properties": {
"channel": {
"type": "string",
"description": "The channel sending to.",
"example": "mms",
"enum": [
"mms"
]
},
"destination": {
"$ref": "#/components/schemas/Destination"
}
}
}
]
},
"messageStatusWhatsApp": {
"allOf": [
{
"$ref": "#/components/schemas/messageStatusBase"
},
{
"title": "WhatsApp",
"x-tab-id": "WhatsApp",
"description": "WhatsApp",
"properties": {
"channel": {
"type": "string",
"description": "The channel sending to.",
"example": "whatsapp",
"enum": [
"whatsapp"
]
},
"status": {
"example": "read",
"enum": [
"submitted",
"delivered",
"rejected",
"undeliverable",
"read"
]
},
"usage": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "EUR",
"description": "The charge currency in ISO 4217 format.",
"enum": [
"EUR"
]
},
"price": {
"type": "string",
"example": "0.0333",
"description": "The charge amount as a stringified number. For WhatsApp this is the default Vonage charge per conversation."
}
}
},
"whatsapp": {
"type": "object",
"description": "An object contining meta-data related to the WhatsApp message that triggered this callback. Only present for callbacks with a `status` of `delivered`.",
"properties": {
"conversation": {
"type": "object",
"description": "An object contining data for the conversation to which the message relates.",
"properties": {
"id": {
"type": "string",
"example": "1234567890",
"description": "The id of the conversation."
},
"origin": {
"type": "object",
"description": "An object contining data related to the origin of the conversation.",
"properties": {
"type": {
"type": "string",
"example": "user_initiated",
"description": "The conversation type.",
"enum": [
"marketing",
"utility",
"authentication",
"referral_conversion",
"service"
]
}
}
}
}
}
}
}
}
}
]
},
"messageStatusMessenger": {
"allOf": [
{
"$ref": "#/components/schemas/messageStatusBase"
},
{
"title": "Messenger",
"x-tab-id": "Messenger",
"description": "Messenger",
"properties": {
"channel": {
"type": "string",
"description": "The channel sending to.",
"example": "messenger",
"enum": [
"messenger"
]
},
"status": {
"example": "read",
"enum": [
"submitted",
"delivered",
"rejected",
"undeliverable",
"read"
]
},
"to": {
"$ref": "#/components/schemas/ToId"
},
"from": {
"$ref": "#/components/schemas/FromId"
}
}
}
]
},
"messageStatusViber": {
"allOf": [
{
"$ref": "#/components/schemas/messageStatusBase"
},
{
"title": "Viber",
"x-tab-id": "Viber",
"description": "Viber",
"properties": {
"channel": {
"type": "string",
"description": "The channel sending to.",
"example": "viber_service",
"enum": [
"viber_service"
]
},
"status": {
"example": "read",
"enum": [
"submitted",
"delivered",
"rejected",
"undeliverable",
"read"
]
}
}
}
]
},
"Timestamp": {
"type": "string",
"description": "The datetime of when the event occurred, in `ISO 8601` format.",
"example": "2020-01-01T14:00:00.000Z"
},
"Destination": {
"type": "object",
"properties": {
"network_code": {
"type": "string",
"description": "Code indicating the terminating network for the number to which the message was sent. May not always be included in the message status data.",
"example": "12345"
}
}
},
"InboundViberMessageCommon": {
"title": "Viber",
"x-tab-id": "Viber",
"required": [
"channel",
"message_uuid",
"to",
"from",
"timestamp"
],
"properties": {
"channel": {
"type": "string",
"description": "The channel that the message came in on",
"enum": [
"viber_service"
],
"example": "viber_service"
},
"context": {
"type": "object",
"description": "Object containing contextual details for the inbound message when it is a response to another message.",
"properties": {
"message_uuid": {
"type": "string",
"description": "The ID of the message being replied to.",
"example": "1234567890abcdef"
}
}
},
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToId"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"timestamp": {
"$ref": "#/components/schemas/Timestamp"
}
}
},
"InboundMessengerMessageCommon": {
"title": "Messenger",
"x-tab-id": "Messenger",
"required": [
"channel",
"message_uuid",
"to",
"from",
"timestamp"
],
"properties": {
"channel": {
"type": "string",
"description": "The channel that the message came in on",
"enum": [
"messenger"
],
"example": "messenger"
},
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToId"
},
"from": {
"$ref": "#/components/schemas/FromId"
},
"timestamp": {
"$ref": "#/components/schemas/Timestamp"
}
}
},
"inboundWhatsAppMessageCommon": {
"title": "WhatsApp",
"type": "object",
"x-tab-id": "WhatsApp",
"required": [
"channel",
"message_uuid",
"to",
"from",
"timestamp",
"context_status"
],
"properties": {
"channel": {
"type": "string",
"description": "The channel that the message came in on",
"enum": [
"whatsapp"
],
"example": "whatsapp"
},
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"timestamp": {
"$ref": "#/components/schemas/Timestamp"
},
"profile": {
"$ref": "#/components/schemas/Profile"
},
"context_status": {
"type": "string",
"description": "Whether or not there is a context for this inbound message or not. If there is a context, and it is `available`, the context\ndetails will be contained in a `context` object. If there is a context, but it is `unavailable`, or if there is no context for\nmessage (`none`), then there will be no `context` object inluded in the body.\n",
"enum": [
"none",
"available",
"unavailable"
],
"example": "available"
},
"context": {
"$ref": "#/components/schemas/Context"
},
"provider_message": {
"type": "string",
"description": "A message from the channel provider, which may contain a description, error codes or other information"
}
}
},
"Profile": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The WhatsApp number's displayed profile name",
"example": "Jane Smith"
}
}
},
"Context": {
"type": "object",
"description": "This is only present for the Inbound Message where the user is quoting another message. It provides information about the quoted message and/or the product message being responded to.\n",
"required": [
"message_uuid",
"message_from"
],
"properties": {
"message_uuid": {
"type": "string",
"example": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"description": "The UUID of the message being quoted."
},
"message_from": {
"type": "string",
"example": "447700900000",
"description": "The phone number of the **original sender** of the message being quoted in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
},
"WhatsAppNodeReferral": {
"properties": {
"whatsapp": {
"type": "object",
"description": "A node preset for some types of inbound messages which provides additional information about how the inbound message originated.",
"properties": {
"referral": {
"type": "object",
"description": "This is only present for situsations where a user has clicked on a 'WhatsApp' button embedded in an advertisement\nor post on Facebook. Clicking on the button directs the user to the WhatsApp app from where they can send a message.\nThe inbound message will contain this object which includes details of the Facebook advertisement or post which contained the embedded button.\n",
"required": [
"body",
"headline",
"source_id",
"source_type",
"source_url"
],
"properties": {
"body": {
"type": "string",
"example": "Check out our new product offering",
"description": "Body text of the referring advertisement or post."
},
"headline": {
"type": "string",
"example": "New Products!",
"description": "Headline text of the referring advertisement or post."
},
"source_id": {
"type": "string",
"example": "212731241638144",
"description": "Meta/WhatsApp ID of the referring advertisement or post."
},
"source_type": {
"type": "string",
"example": "post",
"description": "The type of the referring advertisement or post."
},
"source_url": {
"type": "string",
"example": "https://fb.me/2ZulEu42P",
"description": "A URL referencing the content of the media shown in the advertisement when the user clicked to send a message."
}
}
}
}
}
}
},
"WhatsAppNodeOrder": {
"properties": {
"whatsapp": {
"type": "object",
"description": "A node preset for some types of inbound messages which provides additional information about how the inbound message originated.",
"properties": {
"whatsapp_referred_product": {
"type": "object",
"description": "An object containing details of a product from a `product` message being quoted or replied to using the 'Message Business' option.\n",
"required": [
"catalog_id",
"product_retailer_id"
],
"properties": {
"catalog_id": {
"type": "string",
"example": "1267260820787549",
"description": "The ID of the catalog associated with the product from the `product` message being quoted or replied to using the 'Message Business' option."
},
"product_retailer_id": {
"type": "string",
"example": "r07qei73l7",
"description": "The ID of the product from the `product` message being quoted or replied to using the 'Message Business' option."
}
}
}
}
}
}
},
"Usage": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "EUR",
"description": "The charge currency in ISO 4217 format.",
"enum": [
"EUR"
]
},
"price": {
"type": "string",
"example": "0.0333",
"description": "The charge amount as a stringified number."
}
}
},
"inboundMessageMMS": {
"title": "MMS",
"x-tab-id": "MMS",
"type": "object",
"required": [
"channel",
"message_uuid",
"to",
"from",
"timestamp"
],
"properties": {
"channel": {
"type": "string",
"enum": [
"mms"
],
"description": "The channel the message came in on",
"example": "mms"
},
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"timestamp": {
"$ref": "#/components/schemas/Timestamp"
}
}
},
"inboundMessageSMS": {
"title": "SMS",
"type": "object",
"required": [
"channel",
"message_uuid",
"to",
"from",
"timestamp",
"text"
],
"properties": {
"channel": {
"type": "string",
"enum": [
"sms"
],
"description": "The channel the message came in on",
"example": "sms"
},
"message_uuid": {
"$ref": "#/components/schemas/MessageUuid"
},
"to": {
"$ref": "#/components/schemas/ToNumber"
},
"from": {
"$ref": "#/components/schemas/FromNumber"
},
"timestamp": {
"$ref": "#/components/schemas/Timestamp"
},
"text": {
"example": "Hello From Vonage!",
"type": "string",
"description": "The UTF-8 encoded text of the inbound message.\n"
},
"sms": {
"description": "Channel specific metadata for SMS",
"type": "object",
"properties": {
"num_messages": {
"type": "string",
"example": "2",
"description": "The 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 form a single message. This number indicates how many messages formed this webhook."
},
"keyword": {
"type": "string",
"example": "HELLO",
"description": "The first word of the message sent to uppercase."
}
}
},
"usage": {
"$ref": "#/components/schemas/Usage"
}
}
}
}
},
"x-errors": {
"1000": {
"description": "Throttled - You have exceeded the submission capacity allowed on this account. Please wait and retry"
},
"1010": {
"description": "Missing params - Your request is incomplete and missing some mandatory parameters."
},
"1020": {
"description": "Invalid params - The value of one or more parameters is invalid."
},
"1021": {
"description": "Invalid tag - The tag value is invalid."
},
"1022": {
"description": "Invalid template - Invalid template or template parameters"
},
"1030": {
"description": "Internal error - There was an error processing your request in the Platform."
},
"1040": {
"description": "Invalid message - The Platform was unable to process your request. For example, due to an unrecognised prefix for the phone number."
},
"1050": {
"description": "Number barred - The number you are trying to submit to is blacklisted and may not receive messages."
},
"1060": {
"description": "Partner account barred - The `api_key` you supplied is for an account that has been barred from submitting messages."
},
"1070": {
"description": "Partner quota exceeded - Your pre-paid account does not have sufficient credit to process this message."
},
"1080": {
"description": "Account not enabled for REST - This account is not provisioned for REST submission, you should use SMPP on the SMS API."
},
"1090": {
"description": "Message too long - The length of `udh` and `body` was greater than 140 octets for a binary type SMS request."
},
"1100": {
"description": "Communication Failed - Message was not submitted because there was a communication failure."
},
"1120": {
"description": "Illegal Sender Address - rejected - Due to local regulations, the `SenderID` you set in from in the request was not accepted. Please check the Global messaging section."
},
"1130": {
"description": "Invalid TTL - The value of `ttl` in your request was invalid."
},
"1140": {
"description": "Facility not allowed - Your request makes use of a facility that is not enabled on your account."
},
"1150": {
"description": "Invalid Message class - The value of `message-`class in your request was out of range. See https://en.wikipedia.org/wiki/Data_Coding_Scheme."
},
"1160": {
"description": "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": {
"description": "Invalid or Missing Msisdn Param - The phone number you supplied in the to parameter of your request was either missing or invalid."
},
"1180": {
"description": "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": {
"description": "Absent Subscriber Permanent - `to` is no longer active, You should remove this phone number from your database."
},
"1200": {
"description": "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": {
"description": "Anti-Spam Rejection - Carriers often apply restrictions that block messages following different criteria. For example on SenderID or message content."
},
"1220": {
"description": "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": {
"description": "Network Error - A network failure while sending your message. This is a temporary failure, retry later for a positive result."
},
"1240": {
"description": "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": {
"description": "Too many send requests - Too many send requests to phone numbers."
},
"1250": {
"description": "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."
},
"1260": {
"description": "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": {
"description": "Subscriber Age Restriction - The carrier blocked this message because the content is not suitable for to based on age restrictions."
},
"1280": {
"description": "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."
},
"1282": {
"description": "Message blocked by provider - The messaging provider has chosen to block this message. This may be due to content or restrictions imposed by the provider."
},
"1290": {
"description": "Pre-Paid - Insufficient funds - to’s pre-paid account does not have enough credit to receive the message."
},
"1300": {
"description": "Not part of the provider network - The number or ID is not a user in the provider network."
},
"1310": {
"description": "Not suitable device - The user's device can't receive the message."
},
"1320": {
"description": "Message already sent - The message was already sent."
},
"1330": {
"description": "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": {
"description": "Provider error - The provider is not responding or unable to process the request. Please try sending your message in a few minutes time."
},
"1340": {
"description": "Outside of the allowed window - This message is sent outside of allowed response window."
},
"1350": {
"description": "Phone matching fee not paid - Requires phone matching access fee to be paid by the Facebook Page."
},
"1360": {
"description": "TTL was activated - TTL was activated, no callbacks and no charge will be issued."
},
"1370": {
"description": "Expired access Token - Please reauthenticate your Facebook Page with Vonage."
},
"1380": {
"description": "Invalid resource - Please check that the URL your provided to your resource is accessible and valid."
},
"1381": {
"description": "Resource size is too large - Please try sending a smaller media file."
},
"1382": {
"description": "Resource type is invalid - Please check that the file you are trying to send is valid."
},
"1400": {
"description": "Unsupported channel - The channel specified in the request is not supported."
},
"1410": {
"description": "Invalid channel parameters - The value of one or more parameters is invalid."
},
"1420": {
"description": "Invalid sender - The `from` parameter is invalid for the given channel."
},
"1430": {
"description": "Invalid recipient - The `to` parameter is invalid for the given channel."
},
"1440": {
"description": "Invalid message type - The message type specified in the request is not supported for the given channel."
},
"1450": {
"description": "Invalid client reference - The client reference can be a string of up to 100 characters."
},
"1451": {
"description": "Invalid context - the reference to the original message could not be found because it is invalid or no longer available."
},
"1460": {
"description": "Daily message limit exceeded - Check compliance with regulations such as 10DLC."
},
"1470": {
"description": "Fraud Defender Traffic Rule - Rejected due to prefix block list."
},
"1471": {
"description": "Abnormal Sequential Dialing Detected - The High Density Contact Number Range threshold has been exceeded."
},
"1472": {
"description": "Abnormal Traffic Burst Detected - The Relative Increase threshold has been exceeded."
},
"1473": {
"description": "AIT protection - Enforcer reject due to AIT intelligence DB."
},
"1474": {
"description": "Fraud Score Exceeded - Enforcer reject due to fraud score threshold breach."
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment