Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

App Configuration

Manage the invitation of SIP users to the mobile and desktop apps

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • POST/voip/user/{uuid}/app

    Invites the specified SIP user to the mobile app

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the SIP User to be invited

    POST body

    • Name

    • Type

    • Required

      • mobile_number

      • Long

      • True

      The mobile number to invite to the mobile app

    JSON all-fields example:

    {
        "mobile_number" : 447123456789
    }

    Response Details

    201 Response

    {
        "result" : {
            "mobile_number" : 447123456789
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/user/{uuid}/app

    Removes an invite from the specified SIP user, if they have accepted the invite it will delete their registration

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the SIP User to remove from the app

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/user/{uuid}/desktop

    Invites the specified SIP user to the desktop app

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the SIP User to be invited

    POST body

    • Name

    • Type

    • Required

      • email_address

      • String

      • True

      The email address to invite the user to the desktop app with

    JSON all-fields example:

    {
        "email_address" : "user@example.com"
    }

    Response Details

    201 Response

    {
        "result" : {
            "email_address" : "user@example.com"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/user/{uuid}/desktop

    Removes an invite from the specified SIP user, if they have accepted the invite it will delete their registration

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the SIP User to remove from the desktop app

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service