SIP

Get available SIP gateways

Fetch available SIP gateways, filtrated by given parameters. Returns data with pagination.

GET
/api/v1/sip/gateways

Query Parameters

id?array<integer>

List of SIP gateways' unique ids.

is_active?boolean

Optional parameter for filtration. Allows to filter by is_active field.

page?integer

Pagination parameters. Accepts page number. Pagination starts on page=1. If parameter is not provided, the default value of 1 will be set.

page_size?integer

Pagination parameter. Accepts the size of page for pagination. Minimal page size is 1. If parameter is not provided, the default value of 10 will be set.

region?array<string>

List of region values. Allows to filter out SIP gateways with given regions.

sort_by?string

Ordering parameter. Defines by which field the data will be sorted. If parameter is not provided, will be used entity's default ordering. To use entity's default sorting, pass _default as value.

Value in

  • "_default"
  • "id"
  • "name"
  • "region"
  • "created_at"
sort_order?string

Ordering parameter. Defines the order of sorting (asc or desc). If parameter is not provided, will be used entity's default ordering.

Value in

  • "asc"
  • "desc"

Header Parameters

Authorization*string

Your API token

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/sip/gateways" \  -H "Authorization: string"
{  "data": [    {      "address": "string",      "created_at": "string",      "disabled_at": "string",      "hostname": "string",      "id": 0,      "is_active": true,      "name": "string",      "region": "string"    }  ],  "page": 0,  "page_size": 0,  "total": 0,  "total_pages": 0}
Form Call To Action

Contact us

You can always send us a message or email. Weʼd be happy to help you out.