Call rates

List call rates

get

Retrieve a collection of call rates

Authorizations

Query parameters

filterstringoptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringoptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringoptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100optional

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/call_rates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "prefix": "text",
      "type": "LOCAL",
      "free_seconds": 1,
      "grace_period": 1,
      "interval_1": 1,
      "interval_n": 1,
      "postcall_surcharge": 1,
      "price_1": 1,
      "price_n": 1,
      "description": "text"
    }
  ]
}

OK

Create a call rate

post

Add a new call rate into system.

Authorizations

Body

prefixstring · min: 1 · max: 64required

The call prefix of the rating.

typestring · enum · default: "LOCAL"required

The type of the rating:
Can be either:

• LOCAL:
• NATIONAL:
• INTERNATIONAL:
• MOBILE:

Options: LOCAL, NATIONAL, INTERNATIONAL, MOBILE

free_secondsinteger · int32required

Free seconds of the rating.

grace_periodinteger · int32required

Grace period of the rating.

interval_1integer · int32 · min: 1required

The first interval of the rating.

interval_ninteger · int32 · min: 1required

The subsequent interval of the rating after the first one.

connect_feenumber · doublerequired

Connect fee of the rating. Precision is five digits.

postcall_surchargenumber · doublerequired

Postcall surcharge of the rating. Precision is five digits.

price_1number · doublerequired

The price of the first interval. Precision is five digits.

price_nnumber · doublerequired

The price of the subsequent interval after the first one. Precision is five digits.

descriptionstring · max: 1024optional

The description text for this rule.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_rates' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "prefix": "text",
    "type": "LOCAL",
    "free_seconds": 1,
    "grace_period": 1,
    "interval_1": 1,
    "interval_n": 1,
    "connect_fee": 1,
    "postcall_surcharge": 1,
    "price_1": 1,
    "price_n": 1,
    "description": "text"
  }'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve a call rate

get

Retrieve call rate by it's unique ID.

Authorizations

Path parameters

idall ofrequired

The unique ID of billing.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/call_rates/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "prefix": "text",
  "type": "LOCAL",
  "free_seconds": 1,
  "grace_period": 1,
  "interval_1": 1,
  "interval_n": 1,
  "connect_fee": 1,
  "postcall_surcharge": 1,
  "price_1": 1,
  "price_n": 1,
  "description": "text"
}

OK

Update a call rate

post

Update call rate.

Authorizations

Path parameters

idall ofrequired

The unique ID of billing.

The unique ID of the resource.

Body

prefixstring · min: 1 · max: 64optional

The call prefix of the rating.

typestring · enum · default: "LOCAL"optional

The type of the rating:
Can be either:

• LOCAL:
• NATIONAL:
• INTERNATIONAL:
• MOBILE:

Options: LOCAL, NATIONAL, INTERNATIONAL, MOBILE

free_secondsinteger · int32optional

Free seconds of the rating.

grace_periodinteger · int32optional

Grace period of the rating.

interval_1integer · int32 · min: 1optional

The first interval of the rating.

interval_ninteger · int32 · min: 1optional

The subsequent interval of the rating after the first one.

connect_feenumber · doubleoptional

Connect fee of the rating. Precision is five digits.

postcall_surchargenumber · doubleoptional

Postcall surcharge of the rating. Precision is five digits.

price_1number · doubleoptional

The price of the first interval. Precision is five digits.

price_nnumber · doubleoptional

The price of the subsequent interval after the first one. Precision is five digits.

descriptionstring · max: 1024optional

The description text for this rule.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_rates/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "prefix": "text",
    "type": "LOCAL",
    "free_seconds": 1,
    "grace_period": 1,
    "interval_1": 1,
    "interval_n": 1,
    "connect_fee": 1,
    "postcall_surcharge": 1,
    "price_1": 1,
    "price_n": 1,
    "description": "text"
  }'

200

4XX

200

No body

OK