The WhatsApp Manager API enables customers to deploy a WhatsApp cluster, perform One Time Password (OTP) verification, and update profile information
Create and manage in-progress deployments
Verify or resend a One Time Password (OTP)
Update WhatsApp profile
Stickerpack Management
Sticker Management
Create and manage in-progress deployments
This API request provisions a WhatsApp cluster. Once provisioned, the cluster progresses through the following deployment stages: INITIALIZING
, CREATING_CLUSTER
and CLUSTER_CREATED
. When the CLUSTER_CREATED
stage is reached an OTP voice call or SMS is sent to the specified number and the deployment status becomes CODE_SENT
. When the OTP is received, call the Verify API to complete the process.
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The international dialing code of the number being provisioned
The WhatsApp number being provisioned.
The certificate, which you can retrieve from your WhatsApp Business dashboard.
Note this value is refreshed whenever you click the View button.
The method for delivering the OTP
Must be one of:sms
or voice
WABA ID of the WhatsApp Number
Required if you previously set a PIN when creating a WhatsApp number.
The Deployment id
The WhatsApp Business Account (WABA) ID of the WhatsApp number
The international dialing code of the deployment e.g. 44
for the United Kingdom.
The phone number of the deployment (minus the international dialing code) e.g. 7700900000
The API key associated with the deployment.
The current status of the deployment
The current status of the deployment.
One of:INITIALIZING
, CREATING_CLUSTER
, CLUSTER_CREATED
, CODE_SENT
, WRONG_CODE
, CODE_VERIFIED
, FINALIZING
, READY
, ERROR
, DELETING
or DELETED
Description of the deployment status e.g. Invalid vname certificate
{
"country_code": "44",
"number": "8675309",
"vname_certificate": "AbCdEFGHiJK123456",
"method": "sms",
"waba_id": "123456789123"
}
{
"country_code": "44",
"number": "8675309",
"vname_certificate": "AbCdEFGHiJK123456",
"method": "sms",
"waba_id": "123456789123",
"pin": "123456"
}
{
"deployment_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"waba_id": "abc123",
"country_code": "44",
"number": "7700900000",
"api_key": "abcd1234",
"current_state": {
"title": "INITIALIZING",
"detail": "Initializing deployment"
}
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#forbidden",
"title": "Forbidden",
"detail": "Your account does not have permission to perform this action - see https://www.vonage.com/communications-apis/contact-api/ for more details about getting signed up to send WhatsApp messages.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#number-in-use",
"title": "Number already in use",
"detail": "Active deployment already exists with id 21801df5-a3f6-4bd6-8b66-5bde51a909c7",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Retrieves information about the deployment at the given deployment id.
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The Deployment id
The WhatsApp Business Account (WABA) ID of the WhatsApp number
The international dialing code of the deployment e.g. 44
for the United Kingdom.
The phone number of the deployment (minus the international dialing code) e.g. 7700900000
The API key associated with the deployment.
The current status of the deployment
The current status of the deployment.
One of:INITIALIZING
, CREATING_CLUSTER
, CLUSTER_CREATED
, CODE_SENT
, WRONG_CODE
, CODE_VERIFIED
, FINALIZING
, READY
, ERROR
, DELETING
or DELETED
Description of the deployment status e.g. Invalid vname certificate
{
"deployment_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"waba_id": "abc123",
"country_code": "44",
"number": "7700900000",
"api_key": "abcd1234",
"current_state": {
"title": "INITIALIZING",
"detail": "Initializing deployment"
}
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Delete a WhatsApp deployment
DELETE
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id
Host
https://api.nexmo.com
DELETE
/v0.1/whatsapp-manager/deployments/:deployment_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
No Content
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#conflict-deployment-state",
"title": "Conflict",
"detail": "Deployment cannot be deleted because it is in the DELETING state.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Verify or resend a One Time Password (OTP)
If you do not receive the code in five minutes then you can request for it to be sent again.
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/resend-otp
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments/:deployment_id/resend-otp
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The method for delivering the OTP
Must be one of:sms
or voice
The method the OTP resend will use.
{
"method": "sms"
}
{
"message": "Code sent",
"vname": "your vname",
"method": "sms"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#conflict-resend-otp",
"title": "Deployment Completed, Resend Failed",
"detail": "OTP not required.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#throttled",
"title": "Throttled",
"detail": "Exceeded rate limit for this API, please wait and try again",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
When a code is successfully verified, WhatsApp Manager will move the number from a CODE_VERIFIED
state to a FINALIZING
state where additional checks are made and it is assigned to your API Key. Once this is complete it will enter a READY
state and the number is ready to use.
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/verify
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments/:deployment_id/verify
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
OTP being submitted for verification
the id of your deployment
{
"code": "674639"
}
{
"deployment_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"status": "Deployment was Created"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#verification-failed",
"title": "Verification Failed",
"detail": "Deployment could not be created because the verification failed.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf",
"invalid_parameters": [
{
"name": "code",
"reason": "Invalid code provided."
}
]
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#throttled",
"title": "Throttled",
"detail": "Exceeded rate limit for this API, please wait and try again",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Update WhatsApp profile
Gets business profile information
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/profile
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/profile
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
Text to display in your profile's About section - max 139 characters.
Your business address - max 256 characters.
a description of your business - max 256 characters
Your business' email - max 128 characters
Your business' industry - must be recognized by WhatsApp.
One of:Automotive
, Beauty, Spa and Salon
, Clothing and Apparel
, Education
, Entertainment
, Event Planning and Service
, Finance and Banking
, Food and Grocery
, Public Service
, Hotel and Lodging
, Medical and Health
, Non-profit
, Professional Services
, Shopping and Retail
, Travel and Transportation
, Restaurant
or Other
Your business' websites maximum of 2 websites, max website length: 256
{
"about": "about your business",
"address": "123 main street",
"description": "your business description",
"email": "you@example.com",
"vertical": "Food and Grocery",
"websites": [
"https://example.com"
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Updates profile information for deployment.
PATCH
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/profile
Host
https://api.nexmo.com
PATCH
/v0.1/whatsapp-manager/deployments/:deployment_id/profile
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
Provision WhatsApp deployment and trigger OTP.
Text to display in your profile's About section - max 139 characters.
Your business address - max 256 characters.
a description of your business - max 256 characters
Your business' email - max 128 characters
Your business' industry - must be recognized by WhatsApp.
Must be one of:Automotive
, Beauty, Spa and Salon
, Clothing and Apparel
, Education
, Entertainment
, Event Planning and Service
, Finance and Banking
, Food and Grocery
, Public Service
, Hotel and Lodging
, Medical and Health
, Non-profit
, Professional Services
, Shopping and Retail
, Travel and Transportation
, Restaurant
or Other
Your business' websites maximum of 2 websites, max website length: 256
Text to display in your profile's About section - max 139 characters.
Your business address - max 256 characters.
a description of your business - max 256 characters
Your business' email - max 128 characters
Your business' industry - must be recognized by WhatsApp.
One of:Automotive
, Beauty, Spa and Salon
, Clothing and Apparel
, Education
, Entertainment
, Event Planning and Service
, Finance and Banking
, Food and Grocery
, Public Service
, Hotel and Lodging
, Medical and Health
, Non-profit
, Professional Services
, Shopping and Retail
, Travel and Transportation
, Restaurant
or Other
Your business' websites maximum of 2 websites, max website length: 256
{
"about": "about your business",
"address": "123 main street",
"description": "your business description",
"email": "you@example.com",
"vertical": "Food and Grocery",
"websites": [
"https://example.com"
]
}
{
"about": "about your business",
"address": "123 main street",
"description": "your business description",
"email": "you@example.com",
"vertical": "Food and Grocery",
"websites": [
"https://example.com"
]
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#unprocessable-profile-update",
"title": "Unprocessable Entity",
"detail": "Description was longer than 256 characters and could not be processed.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf",
"invalid_parameters": [
{
"name": "email",
"reason": "Email format invalid"
}
]
}
Gets business profile photo
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/profile/photo
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/profile/photo
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
Url where the profile photo was pulled from
{
"image_url": "https://www.example.com/img.png"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Replaces profile photo with photo at the given URL for the deployment.
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/profile/photo
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments/:deployment_id/profile/photo
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
URL pointing to a .png or .jpg. Image must be minimum 192px. max 640px x 640px. max 5MB.
URL pointing to a .png or .jpg. Image must be minimum 192px. max 640px x 640px. max 5MB.
Url where the profile photo was pulled from
{
"image_url": "https://www.example.com/img.png"
}
{
"image_url": "https://www.example.com/img.png"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#unprocessable",
"title": "Unprocessable Entity",
"detail": "Request was missing a waba_id and could not be processed",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf",
"invalid_parameters": [
{
"name": "url",
"reason": "Url was not in a valid format"
}
]
}
Stickerpack Management
Gets Third-Party Stickerpacks
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
{
"stickerpacks": [
{
"id": "sticker-pack-id1"
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Creates a Third-Party Sticketpack
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
URL pointing to a .png or .jpg. Image must be minimum 192px. max 640px x 640px. max 5MB.
The name of the publisher of the third-party stickerpack.
The name of the stickerpack.
The link to the stickerpack in the Apple iOS App Store. The link follows the format https://itunes.apple.com/app/idXXXXXXXXX. To get your App Store link, refer to the instructions at https://stackoverflow.com/questions/4137426/get-itunes-link-for-app-before-submitting
The link to the stickerpack in the Google Play store. The link follows the format https://play.google.com/store/apps/details?id=com.example where com.example is your app's package name.
{
"publisher": "your-publisher-name",
"name": "your-sticker-pack-name"
}
{
"publisher": "your-publisher-name",
"name": "your-sticker-pack-name",
"ios_app_store_link": "https://itunes.apple.com/app/id3133333",
"android_app_store_link": "https://play.google.com/store/apps/details?id=com.example"
}
{
"stickerpacks": [
{
"id": "sticker-pack-id1"
}
]
}
{
"type": "https://developer.vonage.com/api-errors/whatsapp-provisioning#invalid-json",
"title": "Invalid JSON",
"detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Gets First-Party (WhatsApp) Stickerpacks
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
{
"stickerpacks": [
{
"id": "sticker-pack-id1"
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Gets a specific stickerpack
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The stickerpack ID
{
"stickerpacks": [
{
"name": "sticker-pack-name",
"publisher": "sticker-pack-publisher",
"android_app_store_link": "https://play.google.com/store/apps/details?id=com.example",
"ios_app_store_link": "https://itunes.apple.com/app/id3133333"
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Sticker Management
Retrieve stickers from a stickerpack
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The stickerpack ID
{
"stickers": [
{
"index": "sticker-index1"
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Create Third-Party Stickers
POST
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers
Host
https://api.nexmo.com
POST
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The stickerpack ID
The ID for the sticker media.
An array of the emojis included in the stickerpack.
{
"image_data_id": "id"
}
{
"image_data_id": "id",
"emojis": [
"đ„",
"đ"
]
}
{
"stickers": [
{
"index": "sticker-index1"
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Gets Third-Party Sticker
GET
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers/:sticker_index
Host
https://api.nexmo.com
GET
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers/:sticker_index
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The stickerpack ID
The sticker index
{
"stickers": [
{
"id": "sticker-media-id",
"image_data_id": "sticker-image-media-id",
"emojis": [
{}
]
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
Delete Third-Party Sticker
DELETE
https://api.nexmo.com/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers/:sticker_index
Host
https://api.nexmo.com
DELETE
/v0.1/whatsapp-manager/deployments/:deployment_id/stickerpacks/:stickerpack_id/stickers/:sticker_index
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The deployment ID
The stickerpack ID
The sticker index
{
"stickers": [
{
"id": "sticker-media-id",
"image_data_id": "sticker-image-media-id",
"emojis": [
{}
]
}
]
}
{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "You did not provide correct credentials.",
"detail": "Check that you're using the correct credentials, and that your account has this feature enabled",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "Deployment does not exist or you do not have access.",
"instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}
The following is a non-exhaustive list of error codes that may occur while using this API. These codes are in addition to any of our generic error codes.
Code | Details |
---|---|
number-in-use | Cannot use number because it's already in use by another deployment. |
invalid-json | The request body did not contain valid JSON |
unprocessable | Parameters were valid JSON but something was missing or wrongly formatted |
unprocessable-profile-update | Parameters were valid JSON but something was missing or wrongly formatted |
throttled | Too many requests have been made on this endpoint |
verification-failed | Verification step failed. Either because the the provided code was incorrect or because too many attempts have been made |
conflict-deployment-state | Deployment could not be modified because it is currently in a transitional state. |
conflict-resend-otp | Could not resend OTP because the current state of the deployment did not allow it |