API docs by Redocly

Skyetel API (1.0.0)

Download OpenAPI specification:Download

Introduction

API / Developer Support

The Skyetel API is intended for advanced administrators who either have development experience themselves, or have access to others who have their own development experience. Because of this, our support department is only able to provide very limited support with API and development questions. Our development team is not customer facing and is not able to provide any additional support beyond what limited support our regular support department can offer. More Info

API Keys

API Keys can be generated for the X-AUTH-SID and X-AUTH-SECRET headers in the Skyetel Portal under Settings - API Keys

Rate Limiting

All API requests are rate limited. A maximum of 120 requests per minute are allowed. After this limit is exceeded all API requests will return a 429 error: Too Many Requests

Audio Recordings

Get Audio Recordings

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Audio Recording Download URL

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "download_url": "string"
}

Audio Transcriptions

Get Audio Transcriptions

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Audio Transcription Download URL

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "download_url": "string"
}

Billing

Get Billing Balance

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
{
  • "BALANCE": "string",
  • "credit": true
}

Get Org Statement

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
year
integer

Statement Year i.e. 2019

month
integer

Statment Month i.e. 1 (January)

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "taxes": [
    ],
  • "statement": {
    }
}

CNAM

Get CNAM

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
phonenumber
required
string^1[0-9]{10}$

11-digit phonenumber starting with '1' for US

Responses

Response samples

Content type
application/json
{
  • "name": "string"
}

Endpoints

Get Endpoints

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Endpoint

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
Request Body schema: application/x-www-form-urlencoded
endpoint_id
string

Endpoint UUID

ip
required
string

IPv4 Address

port
integer

Port number for communication (default: 5060)

transport
string
Enum: "UDP" "TCP"

Transport method to use. Only UDP (default) and TCP supported.

priority
required
integer

Arbitrary number to support sorting the IP address inside the Endpoint Group, higher the number, higher the priority.

description
required
string

Short note to describe the Endpoint

endpoint_group_id
required
integer

Endpoint Group ID

endpoint_group_name
required
string

Endpoint Group Name

Responses

Response samples

Content type
application/json
{
  • "endpoint_id": "string",
  • "ip": "string",
  • "port": 0,
  • "transport": "UDP",
  • "priority": 0,
  • "description": "string"
}

Update Endpoint

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
endpoint_id
string

Endpoint UUID

ip
required
string

IPv4 Address

port
integer

Port number for communication (default: 5060)

transport
string
Enum: "UDP" "TCP"

Transport method to use. Only UDP (default) and TCP supported.

priority
required
integer

Arbitrary number to support sorting the IP address inside the Endpoint Group, higher the number, higher the priority.

description
required
string

Short note to describe the Endpoint

endpoint_group_id
required
integer

Endpoint Group ID

endpoint_group_name
required
string

Endpoint Group Name

Responses

Response samples

Content type
application/json
{
  • "endpoint_id": "string",
  • "ip": "string",
  • "port": 0,
  • "transport": "UDP",
  • "priority": 0,
  • "description": "string"
}

Phonenumbers

Get Blocked SMS Numbers

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
[
  • null
]

Get Phonenumber E911 Address

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "caller_name": "string",
  • "address1": "string",
  • "address2": "string",
  • "community": "string",
  • "state": "string",
  • "postal_code": "string"
}

Create Phonenumber E911 Address

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
caller_name
required
string

Company Name

address1
required
string

Street Name

address2
required
string

Suite / Apt #

community
required
string

City / Community

state
required
string

US State Abbrevation

postal_code
required
string

5 Digit Postal Code

Responses

Response samples

Content type
application/json
{
  • "caller_name": "string",
  • "address1": "string",
  • "address2": "string",
  • "community": "string",
  • "state": "string",
  • "postal_code": "string"
}

Update Phonenumber E911 Address

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
caller_name
required
string

Company Name

address1
required
string

Street Name

address2
required
string

Suite / Apt #

community
required
string

City / Community

state
required
string

US State Abbrevation

postal_code
required
string

5 Digit Postal Code

Responses

Response samples

Content type
application/json
{
  • "caller_name": "string",
  • "address1": "string",
  • "address2": "string",
  • "community": "string",
  • "state": "string",
  • "postal_code": "string"
}

Create Off-Network Phonenumber

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
Request Body schema: application/x-www-form-urlencoded
number
string
tenant_id
integer
stir_shaken_enabled
boolean

Responses

Response samples

Content type
application/json
{
  • "SUCCESS": "string"
}

Delete Off-Network Phonenumber

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Update Off-Network Phonenumber

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
tenant_id
integer
stir_shaken_enabled
boolean
message_enabled
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": "string",
  • "stir_shaken_enabled": true,
  • "message_enabled": true,
  • "tenant": { }
}

Get Phonenumbers

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

include
string

Includes fields that are not included by default, i.e. message_destination. Example: include=message_destination,conference_codes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Phonenumber

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Update Phonenumber

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
block_nocid
boolean

Hidden Caller ID Blocked

vfax_external_enabled
boolean

mFax by Documo Enabled

vfax_enabled
boolean

VFax Enabled

conference_bridge_enabled
boolean

Conference Bridge Enabled

spamblock_risk_score
integer

Spam Risk Score is a number from 0 to 100

spamblock_passthru
boolean

Pass Thru Spam Calls

object (lidb_schema)
number
string

Phone Number

forward
string

Forward number, this will forward all incoming calls to the number you specify and will override the Endpoint Selection.

failover
string

Failover number, in the case that an endpoint group is not available, Failover will forward all incoming calls to the number you specify

note
string

Notes about the phone number

alg
integer

The 'algorithm' to use when determining which IP address in the Endpoint Group to direct traffic when the phone number is called

e911_enabled
boolean

Determines whether 911 and 933 (testing number) calls will be accepted from calls that match this phone number as Caller ID

off_network
boolean

Off Network Number

cnam_enabled
boolean

Caller ID Enabled

spamblock_enabled
boolean

Spam Calls Blocked

message_enabled
boolean

SMS/MMS Enabled

tn_format
integer
Enum: 0 10 20

SIP Format, 0 = 1NPANXXXXXX, 10 = NPANXXXXXX, 20 = 1NPANXXXXXX

failure_strategy
integer
Enum: 0 1

Call Failure Routing, 0 = Play an error message, 1 = Retry the call through different regions

object (message_destination_schema)
tier_enabled
integer
Enum: 1 10 20 30

Tier: 1 = 'US/Canada Domestic', 10 = 'Low Fraud Risk Only', 20 = 'High Cost', 30 = 'Very High Cost'

intl_balance
number

Remaining Balance

intl_reserve
number

Fraud Limit

pending_port_out
boolean

Pending Port out

endpoint_group_id
integer

Endpoint Group

tenant_id
integer

Tenant

localpresence_id
integer

Local Presence (Deprecated)

Responses

Response samples

Content type
application/json
{
  • "block_nocid": true,
  • "vfax_external_enabled": true,
  • "vfax_enabled": true,
  • "conference_bridge_enabled": true,
  • "spamblock_risk_score": 0,
  • "spamblock_passthru": true,
  • "lidb": {
    },
  • "number": "string",
  • "forward": "string",
  • "failover": "string",
  • "note": "string",
  • "alg": 0,
  • "e911_enabled": true,
  • "off_network": true,
  • "cnam_enabled": true,
  • "spamblock_enabled": true,
  • "message_enabled": true,
  • "tn_format": 0,
  • "failure_strategy": 0,
  • "message_destination": {
    },
  • "tier_enabled": 1,
  • "intl_balance": 0,
  • "intl_reserve": 0,
  • "pending_port_out": true
}

Find Available Phonenumbers

Search and hold available numbers to order. This API call is required before a number can be ordered and numbers are only held for 10 minutes

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object
 *         Example: filter[states][]=AL&filter[npas][]=509&filter[nxxs][]=123&filter[category]=1&filter[consecutive]=1&filter[quantity]=1&filter[vanity]=4444
 *         states: One or more of state aliases
 *         npas: One ore more 3 digit npa between 100 and 999
 *         nxxs: One or more 3 digit nxx between 100 and 999
 *         category: Category may be 1 (Standard) OR 2 (Exotic) OR 3 (Toll Free)
 *         consecutive: Consecutive must be in a range from 1 to 9999
 *         quantity: Quantity must be in a range from 1 to 10
 *         vanity: Vanity digits with length between 4 and 7 digits,
 *         tnMask  - ten digit number, x as wildcard i.e. 312xxxxxxx, xx4xxxxxx1, xxxxxxxxx
 *         tnWildcard - Telephone number. Accepts 0-9, Aa-Zz, *, or ? (e.g. *Hello* or 312?Hi*7)
 *         lata - 3 digit local access and transport areacode i.e. 422
 *         rateCenter - rate center abbrevation i.e. GRAYSVILLE
 *         sequential - return sequential numbers
 *         province - Two-letter state or province abbreviation (e.g. IL, CA)
 *         city - Name of the City to search for numbers
 *         postalCode - Postal Code to search for numbers
 *         radius - Radius to search for numbers within specified limit. Maximum acceptable value: 50 (miles)
 *         localCallingArea - Send true to retrieve local calling area numbers.
 *         tnMask or tnWildcard are required (even if searching for all TNs). tnMask takes priority if both are specified.
 *         Rate center, city, and postal code are mutually exclusive.
 *         If city is specified, the state must be specified.
 *         Radius is only valid if city and province or zip are specified.
 *         Radius, local, and sequential are mutually exclusive.
 *         In case of local, NPANXX takes priority if city or province or rateCenter specified.
 *         If local is specified, one of the following must be true:
 *              o tnMask or tnWildcard specify the NPANXX (first six digits)
 *              o rateCenter is specified
 *              o city and province are specified (without a radius)
 *              o postal Code is specified (without a radius)
 *

Responses

Response samples

Content type
application/json
[
  • "string"
]

Find Available Rate Centers

Search for available rate centers for a state/province

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
state
required
string

State/province alias i.e. AL

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Order Phonenumbers

Order phonenumbers that have been previously held via Search Available Phonennumbers API

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
Request Body schema: application/x-www-form-urlencoded
numbers
object

List of number objects to purchase and the estimated minutes of usage per month * Example: numbers[15098675309][mou]: 60

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Local Phonenumbers Count

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
{
  • "TOTAL": "string"
}

Get Toll-Free Phonenumbers Count

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
{
  • "TOTAL": "string"
}

SMS/MMS Receipts

Get SMS/MMS Receipts

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stats

Get Endpoint Health

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Org Statement

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
year
integer

Statement Year i.e. 2019

month
integer

Statment Month i.e. 1 (January)

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "taxes": [
    ],
  • "statement": {
    }
}

Get Daily Traffic Counts

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

start_time_min
string <datetime>

Filter data after this date Example: 2019-11-16T00:00:00-08:00

start_time_max
string <datetime>

Filter data before this date Example: 2019-12-16T00:00:00-08:00

tz
string

Format dates for timezone. Example: America/Los_Angeles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Daily Traffic Channels

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

start_time_min
string <datetime>

Filter data after this date Example: 2019-11-16T00:00:00-08:00

start_time_max
string <datetime>

Filter data before this date Example: 2019-12-16T00:00:00-08:00

tz
string

Format dates for timezone. Example: America/Los_Angeles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Daily Traffic Per Hour

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

start_time_min
string <datetime>

Filter data after this date Example: 2019-11-16T00:00:00-08:00

start_time_max
string <datetime>

Filter data before this date Example: 2019-12-16T00:00:00-08:00

tz
string

Format dates for timezone. Example: America/Los_Angeles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tenants

Get Tenant Statements

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
year
integer

Statement Year i.e. 2019

month
integer

Statment Month i.e. 1 (January)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tenant Invoices

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One-Time Invoice

Create a One-time Tenant Billing invoice

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
object (tenant_billing_schema)

Responses

Response samples

Content type
application/json
{
  • "stripe_invoice_id": "string"
}

Void Tenant Invoice

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Get Tenant Billing Products

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tenants

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Tenant

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
Request Body schema: application/x-www-form-urlencoded
id
integer
tenant_code
string
transcription_password
string
transcription_username
string
name
string
address1
string
address2
string
city
string
state
string
country
string
Enum: "US" "CA"
postal_code
string
phonenumber
string
billing_email
string
stripe_cust_id
string
contact_person
string
contact_phonenumber
string
date_added
string
archived
string
object (tenant_billing_schema)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_code": "string",
  • "transcription_password": "string",
  • "transcription_username": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "country": "US",
  • "postal_code": "string",
  • "phonenumber": "string",
  • "billing_email": "string",
  • "stripe_cust_id": "string",
  • "contact_person": "string",
  • "contact_phonenumber": "string",
  • "date_added": "string",
  • "archived": "string",
  • "billing_profile": {
    }
}

Get Tenant

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_code": "string",
  • "transcription_password": "string",
  • "transcription_username": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "country": "US",
  • "postal_code": "string",
  • "phonenumber": "string",
  • "billing_email": "string",
  • "stripe_cust_id": "string",
  • "contact_person": "string",
  • "contact_phonenumber": "string",
  • "date_added": "string",
  • "archived": "string",
  • "billing_profile": {
    }
}

Update Tenant

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
id
integer
tenant_code
string
transcription_password
string
transcription_username
string
name
string
address1
string
address2
string
city
string
state
string
country
string
Enum: "US" "CA"
postal_code
string
phonenumber
string
billing_email
string
stripe_cust_id
string
contact_person
string
contact_phonenumber
string
date_added
string
archived
string
object (tenant_billing_schema)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "tenant_code": "string",
  • "transcription_password": "string",
  • "transcription_username": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "country": "US",
  • "postal_code": "string",
  • "phonenumber": "string",
  • "billing_email": "string",
  • "stripe_cust_id": "string",
  • "contact_person": "string",
  • "contact_phonenumber": "string",
  • "date_added": "string",
  • "archived": "string",
  • "billing_profile": {
    }
}

Get Tenant Endpoints

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tenant Endpoint

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "endpoint_id": "string",
  • "tenant": {
    }
}

Create Tenant Endpoint

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
endpoint_id
string

Responses

Response samples

Content type
application/json
{
  • "endpoint_id": "string"
}

Delete Tenant Endpoint

path Parameters
id
required
integer <int64>
endpoint_id
required
string

Responses

Get Tenant Features

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "cnam_enabled": true,
  • "e911_enabled": true,
  • "message_enabled": true,
  • "spamblock_enabled": true,
  • "vfax_enabled": true,
  • "voicemail_transcription_enabled": true
}

Get Tenant Monthly Stats

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "inbound_minutes": true,
  • "outbound_minutes": true,
  • "channel_count": true
}

Get Tenant Current Stats

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "e911_enabled_count": true,
  • "sms_mms_count": true,
  • "audio_transcription_count": true,
  • "cnam_count": true,
  • "spamblock_count": true
}

Get Org Tenant Users

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Tenant Users

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Tenant User

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
path Parameters
id
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
email
string
password
string

Responses

Response samples

Content type
application/json
"{ERROR: 'Tenant not found'}"

Delete Tenant User

path Parameters
id
required
integer <int64>
userID
required
string

Responses

Faxes

Get Faxes

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
query Parameters
object

Sets the the number of items per page(offset) returned. Example: page[limit]=100&page[offset]=0

object

Performs a wildcard search on all string type fields in the object. Example: filter[query]=123

object

Performs a search on fields in the object. Example: filter[field1]=123&filter[field2]=456

sort
string

Performs a sort on any field in the object, ASC or DESC (-). Example: sort=field1,-field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Send Fax

Authorizations:
(X-AUTH-SIDX-AUTH-SECRET)
Request Body schema: multipart/form-data
src_route
required
string

The 'From' phone number should be in your Skyetel inventory

dst_route
required
string

Destination phone number

file
required
string <binary>

Only allows files with Content-Type: application/pdf

Responses

Response samples

Content type
application/json
{
  • "callid": "string",
  • "start_time": "string",
  • "src_route": "string",
  • "dst_route": "string",
  • "duration": "string",
  • "fax_detail": "string",
  • "fax_pages": "string",
  • "fax_status": "string",
  • "pdf_size": "string",
  • "schedule_fax": "string",
  • "tenant_id": "string"
}

Get Fax Download URL

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "download_url": "string"
}