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.
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.
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.
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. |
This
is our v1 of our API.
Any API changes are announced are available from our Release Notes.
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"
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.
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"} />
Score
Lookup a caller risk score
On a scale of 0.001-5.000 a score is returned with 5 characters (number with 3 decimal places). required: true
Authorizations:
path Parameters
| src
required
|
integer
>= 11
Example:
14165551234
The source caller including country code (without +) |
| dst
required
|
integer
>= 11
Example:
14165554321
The destination caller including country code (without +) |
Responses
Response samples
- 200
{- "data": {
- "score": 3.123
}
}
Name
Lookup a caller risk score
On a scale of 0.001-5.000 a score is returned with 5 characters (number with 3 decimal places).
Authorizations:
path Parameters
| src
required
|
integer
>= 11
Example:
14165551234
The source caller including country code (without +) |
| dst |
integer
>= 11
Example:
14165554321
The destination caller including country code (without +) |
Responses
Response samples
- 200
{- "data": {
- "name": "CALLER NAME"
}
}
Regional
Lookup a caller's regional information
Includes Country, State/Province, City and relative coordinates.
Authorizations:
path Parameters
| src
required
|
integer
>= 11
Example:
14165551234
The source caller including country code (without +) |
| dst |
integer
>= 11
Example:
14165554321
The destination caller including country code (without +) |
Responses
Response samples
- 200
{- "data": {
- "phoneNumber": 14165551234,
- "regional": {
- "city": "Toronto",
- "region": "ON",
- "country": "CA",
- "longitude": -79.382535,
- "latitude": 43.651804
}
}
}
Telco
Lookup a caller's telco provider information
Includes if phone number is a Wireline, Wireless or VoIP source.
Authorizations:
path Parameters
| src
required
|
integer
>= 11
Example:
14165551234
The source caller including country code (without +) |
| dst |
integer
>= 11
Example:
14165554321
The destination caller including country code (without +) |
Responses
Response samples
- 200
{- "data": {
- "phoneNumber": 14165551234,
- "telco": {
- "carrier": "BELL ONTARIO (8051)",
- "company": "BELL Canada",
- "provider": null,
- "type": "Wireline",
- "lata": 888,
- "lir": 805106,
- "switch": "TORTONEV2MD"
}
}
}
Profile
Lookup a caller's web presence / profile information
Includes any related phone numbers, emails and social networks found.
Authorizations:
path Parameters
| src
required
|
integer
>= 11
Example:
14165551234
The source caller including country code (without +) |
| dst |
integer
>= 11
Example:
14165554321
The destination caller including country code (without +) |
Responses
Response samples
- 200
{- "data": {
- "phoneNumber": 14165551234,
- "profile": {
- "title": "Example phone number company",
- "description": "Additional information related to callers phone number.",
- "domain": "example.com",
- "location": {
- "address": "123 Example St.",
- "city": "Toronto",
- "region": "ON"
}, - "email": [
- [
- "jondoh@example.com",
- "janedoh@example.com"
]
], - "phone": [
- [
- 14165551234,
- 14165554321
]
], - "social": [
- [
- "linkedin.com/company/example-co",
- "facebook.com/example-co/"
]
]
}
}
}