Nexmo

External Accounts API

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

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 9

Application

  • POSTLink application to an account/:provider/:external_id/applications
  • DELETEUnlink application from an account/:provider/:external_id/applications/:application_id

Account

  • GETRetrieve all accounts you own/?provider=messenger&page_number=1&page_size=1

Facebook Messenger

  • POSTCreate a Messenger account/messenger
  • GETRetrieve a Messenger account/messenger/:external_id
  • DELETEDelete a Messenger account/messenger/:external_id
  • PATCHUpdate a Messenger account/messenger/:external_id

Viber Service Message

  • GETRetrieve a Viber Service Message account/viber_service_msg/:external_id

WhatsApp

  • GETRetrieve a Whatsapp account/whatsapp/:external_id

API details

Base URL
https://api.nexmo.com/beta/chatapp-accounts
Authentication
HTTP Basic authentication (username and password)
A bearer token in the Authorization header
Operations
9 operations on 7 pathsGET 4POST 2DELETE 2PATCH 1
Main resources
Facebook Messenger 4Application 2Account 1Viber Service Message 1WhatsApp 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 0.1.5
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the External Accounts API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the External Accounts API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Link application to an account” (POST /:provider/:external_id/applications), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the External Accounts API?

The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the… It is listed under Other and has 9 endpoints.

Who publishes the External Accounts API?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the External Accounts API?

Requests go to https://api.nexmo.com/beta/chatapp-accounts. Endpoint paths are added to this base URL.

How do I authenticate with the External Accounts API?

It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.

How many endpoints does the External Accounts API have?

9 operations on 7 paths (4 GET, 2 POST, 2 DELETE, 1 PATCH). The largest groups are Facebook Messenger, Application, Account, Viber Service Message.

Is forking the External Accounts API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.