РАЗРАБОТКА

Документация

IM-сообщения WhatsApp, Viber, Telegram, iMessage

Документация для разработчиков

Добро пожаловать в документацию для разработчиков Nexmo. Ознакомьтесь с понятиями, общими для наших API и продуктов затем начните создавать связанные приложения с нами.

Код

curl -X GET "https://api.nexmo.com/verify/json?&api_key=$NEXMO_API_KEY&api_secret=$NEXMO_API_SECRET&number=$RECIPIENT_NUMBER&brand=AcmeInc"

Код

nexmo.verify.request({ number: RECIPIENT_NUMBER,
brand: NEXMO_BRAND_NAME
}, (err, result) => {
if (err) {
console.error(err);
} else {
const verifyRequestId = result.request_id;
console.log('request_id', verifyRequestId);
}
});

Код

VerifyResponse response = client.getVerifyClient().verify(RECIPIENT_NUMBER, "NEXMO");
if (response.getStatus() == VerifyStatus.OK) {
System.out.printf("RequestID: %s", response.getRequestId());
} else {
System.out.printf("ERROR! %s: %s", response.getStatus(), response.getErrorText());
}

Код

var start = Client.NumberVerify.Verify(new NumberVerify.VerifyRequest
{
number = RECIPIENT_NUMBER,
brand = "AcmeInc"
});
Session["requestID"] = start.request_id;

Код

$verification = new \Nexmo\Verify\Verification(RECIPIENT_NUMBER, 'Acme Inc');
$client->verify()->start($verification);

Код

response = client.start_verification(number=RECIPIENT_NUMBER, brand="AcmeInc")
if response["status"] == "0":
print("Started verification request_id is %s" % (response["request_id"]))
else:
print("Error: %s" % response["error_text"])

Код

response = client.verify.request(
number: RECIPIENT_NUMBER,
brand: 'AcmeInc'
)
if response.status == '0'
# display the Verify `request_id`
puts response.request_id
else
puts response.error_text
end

Концепции

Существует несколько общих концепций между различными API Nexmo:

Приложения - информация о безопасности и конфигурации, необходимая для подключения к Nexmo конечные точки
Аутентификация - ключи API, OAuth и веб-токены JSON (JWT)
OAuth - Как использовать OAuth 1.0a с API Nexmo
Подписание сообщений - Как криптографически подписывать сообщения и проверять подписи
Webhooks - API Nexmo может отправлять данные обратно на ваш веб-сервер через webhook

Вы также можете найти определения часто используемых терминов в Глоссарии.

Продукция

Документация в Nexmo Developer организована по продуктам. В каждом разделе продукта вы найдете следующие виды документации:

Руководства - Ключевые понятия, подчеркивающие основные функции и возможности
Строительные блоки - Примеры кода быстрого доступа, которые помогут вам построить ваши программируемые коммуникационные приложения
Учебники - Шаг за шагом - учебные пособия, помогающие создавать решения для общих случаев использования коммуникаций
Справочник по API - Ресурсы, параметры и примеры полезной нагрузки

Отправить и получить
SMS
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API
Отправить и получить
Голос
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API
Отправить и получить
API разговора
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API
Отправить и получить
Проверка
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API
API Разработчика
Глобальные API

Сообщения и бета рассылка

нтеграция с различными каналами связи, включая Facebook Messenger, WhatsApp и Viber с отказоустойчивостью

Отправить и получить
SMS
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API
Отправить и получить
Голос
- Обзор
- Строительные блоки
- Руководства
- Учебники
Справочник по API

Свяжите свою страницу Facebook с вашей учетной записью Nexmo

Затем вам нужно будет связать свою страницу Facebook с вашей учетной записью Nexmo. Это позволит Nexmo обрабатывать входящие сообщения и отправлять сообщения из API сообщений Nexmo.

Важно: Этот процесс должен быть аутентифицирован JWT. JWT генерируется в этом случае может основываться на любом идентификаторе приложения в вашей учетной записи, так как этот JWT используется только для аутентификации процесс связывания, и он не используется для аутентификации специфичных для приложения вызовов API.

Вам нужно будет вставить действительный JWT. Если у вас его нет, вы можете создать его следующим образом:

Работа с существующими клиентами
С посетителями сайта, которые еще не совершили покупки
С внешней аудиторией.

SMS API

Для отправки и получения SMS

API оповещений - Подписка

Для подписки пользователей на оповещения на основе событий с короткими кодами США

API оповещений - Отправка

Для отправки оповещений на основе событий пользователям с короткими кодами США

2FA

Для проверки пользователей с короткими кодами США

Обзор

Существует несколько общих понятий между API Nexmo: использование веб-токенов JSON (JWT), подписанные запросы, токены OAuth и веб-хуки. Руководства ниже подробно объясняют, как использовать эти элементы.

Руководства

Приложения - информация о безопасности и конфигурации, необходимая для подключения к конечным точкам Nexmo.
Аутентификация - ключи API, OAuth и веб-токены JSON (JWT).
OAuth - как использовать OAuth 1.0a с API Nexmo.
Подписание сообщений - как криптографически подписывать сообщения и проверять подписи сообщений.
Webhooks - API Nexmo может отправлять данные обратно на ваш веб-сервер через webhook.
Глоссарий - глоссарий общих терминов, используемых на всей платформе Nexmo.

Формат номера

В API Nexmo все телефонные номера представлены в формате E.164. Это означает, что цифры:

Опустите как начальный +, так и международный код доступа, такой как 00 или 001.
Не содержат специальных символов, таких как пробел, () или -

Например, номер в США будет иметь формат 14155550101. Номер в Великобритании будет иметь формат 447700900123.

Если вы не знаете, как форматировать номер, можно использовать API Number Insight для поиска правильной информации о номере.

Смотрите также про Формат номера в документации Voice API.

Руководство

Applications - Security and configuration information you need to connect to Nexmo endpoints.
Authentication – API keys, OAuth, and JSON Web Tokens (JWTs).
OAuth – how to use OAuth 1.0a with Nexmo's API.
Signing messages – how to cryptographically sign messages and verify message signatures.
Webhooks – Nexmo's API can send data back to your web server via a webhook.
Glossary – A glossary of common terms used throughout the Nexmo platform.

Приложения

A Nexmo application contains the security and configuration information you need to connect to Nexmo endpoints and easily use our products. You use one or more applications to supply a service based on a Nexmo Product. For example, you may create one Voice application to record calls to your support center, and another application for internal conferences.

Идентификация

Nexmo API provides various means of Authentication depending on what product you are using.

Авторизация

You can use the OAuth 1.0a protocol to give your App authorized access to the Nexmo APIs.

OAuth is an open standard that provides client apps with secure delegated access to HTTP resources on behalf of that resource's owner. It does this by providing access tokens to third-party clients with the approval of the resource owner. The client then uses the access token to access protected resources.

When you use OAuth for authentication:

Nexmo can tell which App and user are calling Nexmo APIs
Your app identifies the user
The user's privacy is protected
Note: We strongly recommend you use an existing OAuth Library for your App.

This section contains:

Setting up OAuth access
Using OAuth in your App
Running the sample App

Подпись в сообщении

You can use signatures with Nexmo when both sending and receiving SMS messages. When sending, you generate a signature to send with your message. When receiving, the incoming webhook will include the signature and all the fields you need to generate the signature in your application to verify that the two signatures match.

You use a signature to:

Verify that a request originates from a trusted source
Ensure that the message has not been tampered with en-route
Defend against interception and later replay

Механизм оповещений

Webhooks are an extension of an API, but instead of your code requesting data from Nexmo, Nexmo sends data to you. The data arrives in a web request to your application. A webhook may be the result of an earlier API call (this type of webhook is also called a "callback"), such as an asynchronous request to the Number Insight API. Webhooks are also used to notify your application of events such as an incoming call or message.

Since the Nexmo servers need to be able to send data to your application via webhooks, you need to set up a webserver to receive the incoming HTTP requests. You also need to specify the URL of each webhook on your webserver so that data can be sent to each one.

Глоссарий

Two-factor authentication: unambiguous identification of users by means of the combination of two different components. For example, to withdraw cash from an ATM, you need both a card and a PIN code. These components may be something that the user knows, something that the user possesses or something that is inseparable from the user.

Many Nexmo customers authenticate their users by sending them a PIN code in an SMS. The user authenticates by entering the PIN into the customer's UI. An example of usage is where the customer requires a password reset. In this case, the two components are the account details and possession of the phone number registered to that account.

See the Wikipedia article.

Обзор

Руководства

Приложения - информация о безопасности и конфигурации, необходимая для подключения к конечным точкам Nexmo.
Аутентификация - ключи API, OAuth и веб-токены JSON (JWT).
OAuth - как использовать OAuth 1.0a с API Nexmo.
Подписание сообщений - как криптографически подписывать сообщения и проверять подписи сообщений.
Webhooks - API Nexmo может отправлять данные обратно на ваш веб-сервер через webhook.
Глоссарий - глоссарий общих терминов, используемых на всей платформе Nexmo.

Формат номера

В API Nexmo все телефонные номера представлены в формате E.164. Это означает, что цифры:

Опустите как начальный +, так и международный код доступа, такой как 00 или 001.
Не содержат специальных символов, таких как пробел, () или -

Например, номер в США будет иметь формат 14155550101. Номер в Великобритании будет иметь формат 447700900123.

Смотрите также про Формат номера в документации Voice API.

Руководство

Applications - Security and configuration information you need to connect to Nexmo endpoints.
Authentication – API keys, OAuth, and JSON Web Tokens (JWTs).
OAuth – how to use OAuth 1.0a with Nexmo's API.
Signing messages – how to cryptographically sign messages and verify message signatures.
Webhooks – Nexmo's API can send data back to your web server via a webhook.
Glossary – A glossary of common terms used throughout the Nexmo platform.

API сообщений

Для обмена сообщениями через SMS / MMS, Facebook Messenger, WhatsApp и Viber Service

API отправки

Для организации рабочих процессов обмена сообщениями с переключением при сбое.

API внешних аккаунтов

Для управления сообщениями Facebook Messenger, WhatsApp и Viber Service учетные записи для использования с сообщениями и диспетчеризацией API.

Обзор

Руководства

Приложения - информация о безопасности и конфигурации, необходимая для подключения к конечным точкам Nexmo.
Аутентификация - ключи API, OAuth и веб-токены JSON (JWT).
OAuth - как использовать OAuth 1.0a с API Nexmo.
Подписание сообщений - как криптографически подписывать сообщения и проверять подписи сообщений.
Webhooks - API Nexmo может отправлять данные обратно на ваш веб-сервер через webhook.
Глоссарий - глоссарий общих терминов, используемых на всей платформе Nexmo.

Формат номера

В API Nexmo все телефонные номера представлены в формате E.164. Это означает, что цифры:

Опустите как начальный +, так и международный код доступа, такой как 00 или 001.
Не содержат специальных символов, таких как пробел, () или -

Например, номер в США будет иметь формат 14155550101. Номер в Великобритании будет иметь формат 447700900123.

Смотрите также про Формат номера в документации Voice API.

API приложения

Создание и управление приложениями Nexmo, которые используются для настройки и аутентификации с помощью Voice API

API преобразования

Улучшить вашу доставляемость сообщений

Медиа API

Управление мультимедийными элементами, такими как аудиофайлы, для использования с другими API Nexmo.

API редактирования

Отредактируйте ваши личные данные на платформе Nexmo

Учетная запись

Получить информацию о ценах, балансе и счете

Сообщения

Получение входящих и исходящих сообщений

Номера

Купить, перечислить и обновить номера вашего счета

Ценообразование

Получить подробную информацию о ценах на услуги

API проверка

Проверьте, есть ли у пользователя номер через SMS и голос.

API проверки - пользовательские шаблоны

Использовать пользовательские шаблоны для изменения сообщений по умолчанию, отправленных API проверки.

Голосовой API

Для совершения и приема звонков.

Объекты управления вызовами Nexmo (NCCO)

Формат JSON для Nexmo API голосовых сообщений.

API формат номера

Умный способ получить в реальном времени информацию о номерах в любой точке мира и защитить себя от мошенничества и спама.

API разговора

Создание каналов связи в реальном времени для текстовых, голосовых и видео сообщений.

Улучшить эту страницу

Мы видим, что эта страница не соответствует вашим ожиданиям. Нам очень жаль!
Мы хотели бы исправить это. Пожалуйста, не могли бы вы дать нам больше информации?
Опишите проблему: (обязательно)