Charge Number

The charge number service allows to set a phonenumber (that belongs to the group) as charge number for a user.

Display user’s charge number

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/charge_number/

Retrieve the settings of the Charge Number service of the user.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/charge_number/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "phoneNumber": "",
     "useForEnhancedTranslations": false,
     "sendToNetwork": false,
}
Response JSON Object:

  • phoneNumber (string) – the number used for the charge number service.

  • useForEnhancedTranslations (boolean) – indicates if the number is used for enhanced translations.

  • sendToNetwork (boolean) – indicates if the number is sent to the network.

Status Codes:

Update a user’s charge number

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/charge_number/

Update the settings of the Charge Number service of the user.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/charge_number/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "phoneNumber": "",
     "useForEnhancedTranslations": false,
     "sendToNetwork": false,
}
Request JSON Object:

  • phoneNumber (string) – the number used for the charge number service.

  • useForEnhancedTranslations (boolean) – indicates if the number is used for enhanced translations.

  • sendToNetwork (boolean) – indicates if the number is sent to the network.

Example response:

HTTP/1.1 200 OK
Status Codes: