Skip to main content
Skip table of contents

Create an IVR Service

POST /Services

Description:
Creates a new IVR service.

Request Body:
The request must be sent as JSON and include the following properties:

  • name (string, required):
    The name for the new IVR service (maximum 50 characters).
    Example: "IVR-IT"

  • phoneNumber (string, required):
    The phone number for the IVR service (maximum 50 characters).
    Example: "668001"

  • tenantId (string, optional):
    The tenant identifier. If omitted or set to null, a default value is used (maximum 255 characters).
    Example: "6649e002-65ec-4eab-a4d6-7f3d493a1311"

Security:
Requires Basic Authentication.

Responses:

  • 201 Created:
    Returns a JSON object with the id of the newly created IVR service.

  • 400 Bad Request:
    Returned when validation errors occur. The response provides a reason code explaining:

    • 0: Some required parameters are missing.

    • 1: Given name is too long.

    • 2: Given phone number is not valid or too long.

    • 3: Given tenant id does not exist.

  • 401 Unauthorized, 403 Forbidden, 409 Conflict, 500 Internal Server Error, 504 Gateway Timeout:
    Standard error responses.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.