nexmo.com

The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the Messages and Dispatch APIs.

🔑 basic 9 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (9 total)

verify-javascript-sdk ✓ Official

npm install verify-javascript-sdk

GitHub integration →

verify-android-sdk ✓ Official

# Maven: see https://github.com/Nexmo/verify-android-sdk

GitHub integration →

react-native-nexmo-verify

# Maven: see https://github.com/artechsio/react-native-nexmo-verify

GitHub integration →

vonage-php-nexmo-bridge ✓ Official

composer require vonage-php-nexmo-bridge

GitHub integration →

verify-ios-sdk ✓ Official

# See https://github.com/Nexmo/verify-ios-sdk

GitHub integration →

client-sdk-voice-app-to-phone-flutter ✓ Official

# Maven: see https://github.com/nexmo-community/client-sdk-voice-app-to-phone-flutter

GitHub integration →

stitch-js-quickstart ✓ Official

# See https://github.com/Nexmo/stitch-js-quickstart

GitHub integration →

server-sdk-specification ✓ Official

# See https://github.com/Nexmo/server-sdk-specification

GitHub integration →

client-sdk-tutorials ✓ Official

# See https://github.com/nexmo-community/client-sdk-tutorials

GitHub integration →

curl examples

Retrieve all accounts you own

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/beta/chatapp-accounts/

Retrieve a Whatsapp account

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/beta/chatapp-accounts/whatsapp/{external_id}

Retrieve a Messenger account

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/beta/chatapp-accounts/messenger/{external_id}

Endpoints (9 total)

GET

Retrieve all accounts you own

GET

/whatsapp/{external_id}

Retrieve a Whatsapp account

GET

/messenger/{external_id}

Retrieve a Messenger account

GET

/viber_service_msg/{external_id}

Retrieve a Viber Service Message account

POST

/messenger

Create a Messenger account

POST

/{provider}/{external_id}/applications

Link application to an account

PATCH

/messenger/{external_id}

Update a Messenger account

DELETE

/messenger/{external_id}

Delete a Messenger account

DELETE

/{provider}/{external_id}/applications/{application_id}

Unlink application from an account