Wprowadzenie

REST API SIP Caller pozwala Twoim aplikacjom pracować z Twoim kontem SIP Caller w taki sam sposób, w jaki robisz to w Konsoli Webowej. Użyj go, aby połączyć SIP Caller ze swoim systemem CRM, ERP, helpdeskiem lub dowolnym systemem wewnętrznym i w pełni zautomatyzować swoje operacje połączeń wychodzących.

Za pomocą API możesz:

• Zarządzać kampaniami: tworzyć, edytować, duplikować i usuwać kampanie, a także je uruchamiać, wstrzymywać lub anulować.
• Zasilać kampanie numerami: dodawać numery pojedynczo lub zbiorczo, wraz z wartościami zmiennych, których Twoje przepływy połączeń i agenci AI używają do personalizacji każdego połączenia, albo kopiować je z listy kontaktów.
• Synchronizować swoje listy: utrzymywać czarne listy i listy kontaktów z poziomu systemów, w których znajdują się te dane.
• Odczytywać wyniki: pobierać szczegóły każdego połączenia i każdego numeru kampanii, aby aktualizować własne rekordy o rezultat.

API uzupełniają webhooki, które w czasie rzeczywistym powiadamiają Twoje systemy, gdy coś wydarzy się w SIP Caller, na przykład gdy kampania zostanie aktywowana lub zakończy się połączenie. Razem pozwalają tworzyć integracje, w których kampanie są tworzone, zasilane i monitorowane bez pracy ręcznej.

REST API i webhooki są dostępne w planach Enterprise SIP Caller. Na stronie Ceny możesz porównać plany i ich funkcje.

Bazowy URL

Wszystkie endpointy opisane w tej dokumentacji są dostępne pod następującym bazowym URL:

https://api.sipcaller.com/v1

API jest udostępniane wyłącznie przez HTTPS. Wersja (v1) jest częścią URL, a każda zmiana niezgodna wstecz zostanie wydana w nowej wersji, dzięki czemu Twoja integracja będzie nadal działać bez zmian.

Żądania i odpowiedzi

API stosuje konwencje REST:

• Zasoby są identyfikowane przez adresy URL, a działania są wyrażane standardowymi metodami HTTP: GET do odczytu, POST do tworzenia, PUT do aktualizacji i DELETE do usuwania.
• Treści żądań i odpowiedzi są w formacie JSON, zakodowane w UTF-8. Wysyłaj nagłówek Content-Type: application/json z każdym żądaniem, które ma treść JSON.
• Pomyślne żądania zwracają kod statusu 2xx. Błędy zwracają kod statusu 4xx lub 5xx, z treścią JSON opisującą problem, zgodnie z opisem w sekcji Błędy.
• Identyfikatory to UUID (na przykład 01a0dedd-b9a2-729d-8e0a-4e3ad9197aea), z wyjątkiem numerów kampanii, czarnych list i list kontaktów, które są identyfikowane liczbami całkowitymi.
• Daty używają formatu YYYY-MM-DD, a znaczniki czasu formatu ISO 8601 bez strefy czasowej (na przykład 2026-09-26T17:57:48.064).

ID konta

Każdy endpoint działa w kontekście Twojego konta SIP Caller, którego ID jest częścią URL:

https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns

ID konta możesz skopiować z Konsoli Webowej, jak pokazano poniżej.

ID innych zasobów, takich jak kampanie, można uzyskać z samego API lub skopiować z Konsoli Webowej:

Pierwsze kroki

1. Utwórz klucz API w Konsoli Webowej, z rolami, których potrzebuje Twoja integracja.
2. Przeczytaj, jak uwierzytelniać swoje żądania.
3. Wypróbuj endpoint Lista kampanii, aby sprawdzić, czy wszystko działa.
4. Przeglądaj dokumentację za pomocą menu po lewej stronie. Każdy endpoint zawiera gotowe do użycia przykłady w cURL, Python, Java, Node.js i .NET: wybierz swój język w panelu kodu, a Twój wybór zostanie zapamiętany na każdej stronie.

W przykładach zastąp API_KEY_TOKEN, ACCOUNT_ID i inne symbole zastępcze pisane wielkimi literami własnymi wartościami.