Call rates

List call rates

Retrieve a collection of call rates

GEThttp://127.0.0.1:8888/api/call_rates

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_rates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "prefix": "text",
      "type": "LOCAL",
      "postcall_surcharge": 0,
      "price_1": 0,
      "price_n": 0,
      "description": "text"
    }
  ]
}

Create a call rate

Add a new call rate into system.

POSThttp://127.0.0.1:8888/api/call_rates

Body

application/json

prefix*string

The call prefix of the rating.

type*enum

The type of the rating:
Can be either:

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

LOCALNATIONALINTERNATIONALMOBILE

free_seconds*integer (int32)

Free seconds of the rating.

grace_period*integer (int32)

Grace period of the rating.

interval_1*integer (int32)

The first interval of the rating.

interval_n*integer (int32)

The subsequent interval of the rating after the first one.

connect_fee*number (double)

Connect fee of the rating. Precision is five digits.

postcall_surcharge*number (double)

Postcall surcharge of the rating. Precision is five digits.

price_1*number (double)

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

price_n*number (double)

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

descriptionstring

The description text for this rule.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of billing.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_rates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "prefix": "text",
      "type": "LOCAL",
      "connect_fee": 0,
      "postcall_surcharge": 0,
      "price_1": 0,
      "price_n": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": {}
}

Retrieve a call rate

Retrieve call rate by it's unique ID.

GEThttp://127.0.0.1:8888/api/call_rates/{id}

Path parameters

id*all of

The unique ID of billing.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of billing.

prefixstring

The call prefix of the rating.

typeenum

The type of the rating:
Can be either:

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

LOCALNATIONALINTERNATIONALMOBILE

free_secondsinteger (int32)

Free seconds of the rating.

grace_periodinteger (int32)

Grace period of the rating.

interval_1integer (int32)

The first interval of the rating.

interval_ninteger (int32)

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

The description text for this rule.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_rates/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "prefix": "text",
  "type": "LOCAL",
  "connect_fee": 0,
  "postcall_surcharge": 0,
  "price_1": 0,
  "price_n": 0,
  "description": "text"
}

Update a call rate

Update call rate.

POSThttp://127.0.0.1:8888/api/call_rates/{id}

Path parameters

id*all of

The unique ID of billing.

Body

application/json

prefixstring

The call prefix of the rating.

typeenum

The type of the rating:
Can be either:

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

LOCALNATIONALINTERNATIONALMOBILE

free_secondsinteger (int32)

Free seconds of the rating.

grace_periodinteger (int32)

Grace period of the rating.

interval_1integer (int32)

The first interval of the rating.

interval_ninteger (int32)

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

The description text for this rule.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_rates/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();