SIPSTACK API
Introduction
SIPSTACK is a real-time communications platform with AI/ML at it's core.
Our API Reference is organized by topics, such as Phone Numbers or Messaging. Each topic is prefaced with a general overview that describes how our API can be used within the context of that topic, followed by reference documentation of specific API endpoints.
SIPSTACK is an API & developer-first platform backed by top tier 24/7 support. Explore our API documentation, and feel free to let us know how we are doing to help serve you better.
Overview
Partner Portal
The SIPSTACK partner portal is the central hub that gives you access to all the products in the SIPSTACK ecosystem. It also allows you to edit/add information relating to your company, brand and payment settings, review invoices, logs and transaction history and also generate api tokens to integrate our products within your systems.
Protocols
SIPSTACK HTTP endpoints are RESTful, expect and return JSON. All HTTP endpoints require an API Key & API Secret (API Token) as part of the request.
More information on API Keys and Authorization headers in the Authentication section below.
Glossary
A telecom glossary is available from https://www.sipstack.com/resources/knowledge-base/general/glossary-telco
A comprehensive SIPSTACK gloassary is available from https://www.sipstack.com/resources/knowledge-base/general/glossary-sipstack
| Term | Description | | --- | --- | | Endpoint | Url of a requested API route. |
Versioning
This is our v1 of our API.
Any API changes are announced are available from our Release Notes.
Authentication
The SIPSTACK API V1 uses API Tokens to authenticate requests. You can view and manage your API Tokens by logging into your [Partner Portal][https://partner.sipstack.com] and navigating to the API Access section in the "Organization / API Access" section.
Your API Tokens carry important privileges, so be sure to keep them secure! Do not share your secret API Tokens in publicly accessible areas such as GitHub, client-side code, etc...
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Curl (Example)
curl -u "<API_KEY>:<API_SECRET>" \
-X GET "https://api.sipstack.com/v1/partner/a/org/token/test"
<SecurityDefinitions />
Errors
We follow the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.
<PullRight> This part will appear in the right pane. </PullRight>
General Error
Please see the messages portion of the JSON response for additional details.
<RedocResponse pointer={"#/components/responses/400"} />
Unauthorized
<RedocResponse pointer={"#/components/responses/401"} />
Not Found
<RedocResponse pointer={"#/components/responses/404"} />
API Requests
Authentication
- HTTP: Basic Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | basic |
Contact
License
Proprietary