API dla numerów telefonów i dokumentów

Instrukcję konfiguracji / Dla programistów i partnerów (praca z API) / API dla numerów telefonów i dokumentów

Korzystając z API możesz wywoływać połączenie i zarządzać numerami wirtualnymi z własnego interfejsu (panelu administratora) bez konieczności logowania się na swoje konto osobiste Zadarma.

Wszystkie funkcje i metody API Zadarma - https://zadarma.com/pl/support/api/

W większości krajów do podłączenia numeru wymagane jest potwierdzenie tożsamości końcowego. Niestandardowe dokumenty są również przesyłane za pośrednictwem interfejsu API.

Funkcje API:

  • wybór i podłączenie numerów wirtualnych
  • konfigurowanie już podłączonych numerów
  • praca z dokumentami w celu podłączenia numerów (informacje o wymaganiach dot. podłączenia, przesyłanie dokumentów, sprawdzanie przesłanych wcześniej dokumentów w celu zamówienia konkretnego numeru)

Kolejność czynności przy zamawianiu numeru przez API:

  1. Uzyskiwanie aktualnej listy krajów i kierunków do zamówienia, wyświetlanie ich użytkownikowi
  2. Uzyskiwanie i wyświetlanie listy numerów dostępnych do zamówienia
  3. Utworzenie grupy dokumentów dla użytkownika (jeśli jeszcze nie została utworzona) i przesłanie dokumentów (jeśli jest to konieczne).
  4. Łączenie wybranego numeru z grupą dokumentów.
  5. Podpięcie numeru do loginu SIP lub SIP URI (set_sip_id)

Podłączanie nowych numerów

Metoda GET /v1/direct_numbers/countries/ uzyskanie listy krajów, w których można zamówić numer, jeśli zapytanie zostanie wysłane bez parametrów, odpowiedź będzie w języku Twojego konta osobistego, dodając opcjonalny parametr language możesz otrzymać odpowiedź w jednym z języków konta osobistego.

Metoda GET /v1/direct_numbers/country/ uzyskanie listy miast w kraju, w którym można zamówić numer. Wymagany parametr country - kod kraju iso (ISO 3166-1 alpha-2); Parametry opcjonalne language i direction_id. W odpowiedzi będzie tablica danych z opisem numeru: kraj, miasto, koszt podłączenia, miesięczny abonament, funkcje, możliwość odbierania SMS-ów itp.

Uzyskanie listy numerów dostępnych do zamówienia, metoda GET /v1/direct_numbers/available/<DIRECTION_ID>/ z parametrami DIRECTION_ID - identyfikator kierunku lub ru495; i mask - ​​to opcjonalny parametr służący do wyszukiwania dopasowań według liczb.

Zamówić numer można za pomocą metody POST /v1/direct_numbers/order/

Już połączony numer można w razie potrzeby przedłużyć na kilka miesięcy za pomocą tej metody POST /v1/direct_numbers/prolong/

Obowiązkowe parametry number i months

Interakcja z już połączonymi numerami

Metoda GET /v1/direct_numbers/ (bez parametrów) zwraca tablicę z informacjami o już podłączonych numerach.

Korzystając z metody GET /v1/direct_numbers/number/ można uzyskać informacje o konkretnym podłączonym numerze, żądanie jest wysyłane z parametrami type i number.

Status automatycznego przedłużenia numeru (czy zostanie automatycznie odnowiony na następny okres, czy wyłączy się po zakończeniu okresu ważności) można znaleźć metodą GET /v1/direct_numbers/autoprolongation/ z parametrami type i number.

Aby zmienić stan automatycznego przedłużania, użyj metody PUT /v1/direct_numbers/autoprolongation/ z parametrami type i number, value.

Metoda PUT /v1/direct_numbers/set_caller_name/ - ustawienie lub włączenie nazwy numeru (alfabet łaciński i cyfry do 30 znaków) opis tekstowy numeru, także w przypadku połączenia przychodzącego przekazywany w nagłówku From jako CALLERID(name). Obowiązkowe parametry type, number i caller_name - aby usunąć nazwę numeru należy podać puste pole.

Korzystając z metody PUT /v1/direct_numbers/set_sip_id/ , możesz wysyłać połączenia z numeru wirtualnego na określony login SIP, serwer zewnętrzny za pomocą SIP URI lub włączyć tryb testowy. Obowiązkowe parametry type, number i sip_id - sip login lub adres zewnętrznego serwera, np. 1234567890@myserver.com test_mode - opcjonalnie, (on|off) - aby włączyć tryb testowy.

Praca z dokumentami

Grupa dokumentów to dane osoby lub firmy, która będzie używać wirtualnego numeru, może być kilka grup.

Tworzenie nowej grupy dokumentów, metoda POST /v1/documents/groups/create/

Możesz aktualizować dane w już istniejącej grupie dokumentów za pomocą metody PUT /v1/documents/groups/update/<GROUPID>/

Przesłanie pliku dokumentu dla grupy dokumentów odbywa się metodą POST /v1/documents/upload/

Metodą GET /v1/documents/groups/list/ można uzyskać listę grup dokumentów a metodą GET /v1/documents/groups/get/<ID>/ - gdzie ID grupy, 0 - główna grupa dokumentów, możesz uzyskać informacje o określonej grupie dokumentów.

Metoda GET /v1/documents/files zwróci listę wcześniej przesłanych plików/dokumentów w grupie dokumentów. group_id - nieobowiązkowy parametr, ID grupy dokumentów, (0 lub nie określony - główna grupa dokumentów).

Sprawdzenie, czy grupa dokumentów nadaje się do zamówienia numeru w konkretnym mieście/kierunku odbywa się metodą GET /v1/documents/groups/valid/<ID>/