CNAM интеграция

Справочник за CNAM REST API

Заявете име на обаждащ се през HTTPS и обработете резултата, таксата и грешките.

Изберете поведението на справката

Ниво	Публична цена за заявка	Какво прави
Starter	0,0026 щ.д.	Използва собствена и кеширана информация за имена на обаждащи се.
Standard	0,0037 щ.д.	Извършва мрежова справка в реално време за всяка заявка.
Mixed	0,004 щ.д.	Първо опитва справка в реално време, а когато не бъде намерено име, преминава към данните на Starter.

Избраната услуга определя поведението на справката; Mixed не е справка, която първо проверява кеша. Прегледайте тарифата, определена за вашия акаунт, преди използване в продукция. Името на обаждащия се не е доказателство за самоличност или собственост.

Изпратете удостоверена справка

Крайна точка: GET https://api.multitel.net/v3/cnam/NUMBER. Използвайте международни цифри, включително кода на държавата, без препинателни знаци и без водещ знак плюс. Изпълнявайте това от сървъра на вашето приложение с одобрени API идентификационни данни.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

Задайте двете променливи на средата чрез конфигурация на тайни от страна на сървъра. Предоставените bearer идентификационни данни са алтернатива само когато този достъп е активиран и ограниченията за IP адрес на източника са изпълнени. Никога не поставяйте API тайна в публичен браузърен пакет.

Ръководство за API удостоверяване и първа заявка

Прочетете JSON отговора

Този отговор е примерен. Върнатото име и таксата зависят от справката и избраната услуга.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}

status.code: Код на резултата на приложението; нормализирайте текстовите/числовите стойности, преди да ги сравните с 200.
status.msg: Придружаващото съобщение за резултата или отказа.
response.number: Търсеният номер.
response.name: Наличното име на обаждащия се.
response.cost: Таксата, отчетена за тази заявка; третирайте я като десетична сума.
response.balance: Отчетеният баланс на акаунта, когато е наличен.

Резултати без име и грешки

Успешната заявка не гарантира полезно име на обаждащ се. Обработвайте празно име, върнат номер вместо име и отхвърлена справка. Кодът на приложението 403 може да означава недостатъчен кредит, забранена покупка или номер без резултат; проверете съобщението.

Проверете както HTTP статуса, така и JSON status, преди да осъществите достъп до response.name. Обектът на отговора може да липсва при грешка. Липсващото име не бива да пречи на нормалното маршрутизиране на обаждането.

Фактуриране, повторни опити и разликата от актуализиране на идентификатора на обаждащия се

Нова справка може да доведе до такса за заявка. Тези интерфейси за справки не документират ключ за идемпотентност, така че нов повторен опит може да бъде втора таксувана заявка. Използвайте ограничено забавяне между опитите при грешки в транспорта/услугата, първо отстранете грешките в акаунта и съгласувайте отчетените такси за заявки. Кеширайте само за период, подходящ за вашето приложение; данните за имената на обаждащите се могат да се променят.

CNAM справката чете име. Тя не променя името, показвано при вашите изходящи обаждания. Актуализацията на име на обаждащ се в LIDB е отделна операция със собствени полета, упълномощаване, цена и обработка.

Ръководство за CNAM интеграция в акаунта Получете помощ за интеграцията