Call rates

PreviousExport NextDestroy

Was this helpful?

List call rates

Retrieve a collection of call rates

get

/call_rates

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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

skipinteger · int32

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: 100

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

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

Create a call rate

Add a new call rate into system.

post

/call_rates

Authorizations

Body

prefixstring · min: 1 · max: 64required

The call prefix of the rating.

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: 1024

The description text for this rule.

typestring · enum · default: LOCALrequired

The type of the rating:
Can be either:

LOCAL:
NATIONAL:
INTERNATIONAL:
MOBILE:

Options: LOCAL, NATIONAL, INTERNATIONAL, MOBILE

Responses

application/json

cURL

JavaScript

Python

HTTP

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","free_seconds":1,"grace_period":1,"interval_1":1,"interval_n":1,"connect_fee":1,"postcall_surcharge":1,"price_1":1,"price_n":1,"type":"LOCAL"}'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a call rate

Retrieve call rate by it's unique ID.

get

/call_rates/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of billing.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "prefix": "text",
  "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",
  "type": "LOCAL",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update a call rate

Update call rate.

post

/call_rates/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of billing.

Body

prefixstring · min: 1 · max: 64

The call prefix of the rating.

free_secondsinteger · int32

Free seconds of the rating.

grace_periodinteger · int32

Grace period of the rating.

interval_1integer · int32 · min: 1

The first interval of the rating.

interval_ninteger · int32 · min: 1

The subsequent interval of the rating after the first one.

connect_feenumber · double

Connect fee of the rating. Precision is five digits.

postcall_surchargenumber · double

Postcall surcharge of the rating. Precision is five digits.

price_1number · double

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

price_nnumber · double

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

descriptionstring · max: 1024

The description text for this rule.

typestring · enum · default: LOCAL

The type of the rating:
Can be either:

LOCAL:
NATIONAL:
INTERNATIONAL:
MOBILE:

Options: LOCAL, NATIONAL, INTERNATIONAL, MOBILE

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_rates/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"type":"LOCAL"}'

200

4XX

No body