Skip to content
/
Get a specific Ignored Ca...

Elevate Reference Data API (1.12)

Reference Data Management

Where possible, Elevate will manage reference data internally via incoming feeds of reliable dialstring and charge group information However, for data sources where this is not possible (e.g. for proprietary/internal data) this can be managed externally via this API

Where a usage product cannot be rated using the dialstring look up method to identify the dialled number, Elevate will rely on call-class to do this instead

Entity model

  • One or many dialstrings map to one reference-data-source-charge-group
  • One or many call-classes map to one reference-data-source-charge-group
  • One or many reference-data-source-charge-groups map to one charge-group and one reference-data-source
  • One or many charge-groups map to one charge-group-category
Download OpenAPI description
billing-rest-reference-data.json
billing-rest-reference-data.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

reference-data-sources

Manage sources of reference data - only manually maintained data sources can be updated via this endpoint

Operations

charge-groups

Management of charge groups and charge group categories

Operations

reference-data-source-charge-groups

Charge group and charge group category management by reference data source

Operations

call-classes

Management of manually maintained call-class information

Operations

ignored-call-classes

Management of manually maintained ignored-call-class information

Operations

Get a list of Ignored Call Classes

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
callClassstring(StringFilterParam)

Filter by ignored call class based on its name

Example: callClass=xyz | in:x,y | like:xyz
startDatestring(DateFilterParam)

Filter ignored call classes based on start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter ignored call classes based on end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/ignored-call-classes?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&callClass=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK (the list of ignored call classes could be returned or empty list)

Bodyapplication/jsonArray [
idinteger(int64)read-only

Internal identifier of ignored call class, it MAY be sent as part of a response but it will be ignored in case of the request

Example: 1
callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

]
Response
application/json
[
  {
    "id": 1,
    "callClass": "Call class name",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }
]

Create new Ignored Call Class

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New Ignored Call Class

callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

curl -i -X POST \
  https://rest.elevatebilling.com/v1/ignored-call-classes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "callClass": "Call class name",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }'

Responses

OK (Ignored Call Class was created)

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of ignored call class, it MAY be sent as part of a response but it will be ignored in case of the request

Example: 1
callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

Response
application/json
{
  "id": 1,
  "callClass": "Call class name",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Check if Ignored Call Class exists

Request

Security
bearerAuth
Query
callClassstring(StringFilterParam)

Check by ignored call class name

Example: callClass=xyz | in:x,y | like:xyz
startDatestring(DateFilterParam)

Check for ignored call class based on start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Check for ignored call class based on end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/ignored-call-classes?callClass=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Headers
X-Total-Countinteger

Total number of call classes

Body

Get a specific Ignored Call Class

Request

Security
bearerAuth
Path
ignored_call_class_idinteger(int64)(IdParam)>= 1required

Ignored Call Class identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/ignored-call-classes/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK (Ignored Call Class found)

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of ignored call class, it MAY be sent as part of a response but it will be ignored in case of the request

Example: 1
callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

Response
application/json
{
  "id": 1,
  "callClass": "Call class name",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Update Ignored Call Class

Request

Security
bearerAuth
Path
ignored_call_class_idinteger(int64)(IdParam)>= 1required

Ignored Call Class identifier

Example: 1
Bodyapplication/jsonrequired

Updated Ignored Call Class

callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/ignored-call-classes/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "callClass": "Call class name",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24"
  }'

Responses

OK (Ignored Call Class was updated)

Bodyapplication/json
idinteger(int64)read-only

Internal identifier of ignored call class, it MAY be sent as part of a response but it will be ignored in case of the request

Example: 1
callClassstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Ignored call class name

Example: "Call class name"
startDatestring(date)

Date this ignored call class applies from. The value is today if it wasn't specified

endDatestring(date)

Date this ignored call class applies to

Response
application/json
{
  "id": 1,
  "callClass": "Call class name",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Delete Ignored Call Class

Request

Security
bearerAuth
Path
ignored_call_class_idinteger(int64)(IdParam)>= 1required

Ignored Call Class identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/ignored-call-classes/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK (Ignored Call Class was deleted)

Body

ignored-service-ids

Management of manually maintained ignored-service-ids information

Operations

dialstrings

Management of manually maintained dialstrings information

Operations

tax-bands

Tax-band management

Operations

currencies

Currencies supported by the system

Operations

locales

Locales supported by the system

Operations

currency-rates

Management of the exchange rates between currencies

Operations

reference-data-summaries

Operations