Fax Messaging Services

Display user’s fax messaging

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

Retrieve the settings of the Fax Messaging service of the user.

Example request:

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

Example response:

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

{
    "active": false,
    "phoneNumber": "",
    "extension": "",
    "aliases": []
}
Response JSON Object:

  • active (boolean) – the status of the service.

  • phoneNumber (string) – the number used to receive faxes from outside the Group.

  • extension (string) – the extension used to receive internal faxes

  • aliases (array) – list of aliases that can be used to reach the fax service.

Status Codes:

Update a user’s fax messaging

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

Update the settings of the Fax Messaging service of the user.

Example request:

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

{
    "active": true,
    "phoneNumber": "+3225126777",
    "aliases": ["testfax@sip.netaxis.be"]
}

Example response:

HTTP/1.1 200 OK
Request JSON Object:

  • active (boolean) – the status of the service. It can be set to True only if a phoneNumber and an extension is configured.

  • phoneNumber (string) – the number used to receive faxes from outside the Group

  • extension (string) – the extension used to receive internal faxes

  • aliases (array) – list of aliases that can be used to reach the fax service.

Status Codes: