Mailbox Email Recipients

Email Recipients receive email notifications when a voicemail is left on their Mailbox

• GET/voip/mailbox/{uuid}/email-recipient

  Gets all email recipients for a Mailbox

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Mailbox to be queried

  Response Details

  200 Response

  {
      "result" : [
          {
              "created_on" : "2023-03-23",
              "updated_on" : "2023-03-23",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• GET/voip/mailbox/{mailbox_uuid}/email-recipient/{recipient_uuid}

  Gets the details for a specific email recipient

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • mailbox_uuid

    • String

    • True

    The UUID of the Mailbox to be queried

  • • recipient_uuid

    • String

    • True

    The UUID of the Email Recipient to be queried

  Response Details

  200 Response

  {
      "result" : {
          "created_on" : "2023-03-23",
          "updated_on" : "2023-03-23",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• POST/voip/mailbox/{uuid}/email-recipient

  Creates a new email recipient for a mailbox

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Mailbox to be queried

  Response Details

  201 Response

  {
      "result" : {
          "created_on" : "2023-03-23",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• DELETE/voip/mailbox/{mailbox_uuid}/email-recipient/{recipient_uuid}

  Deletes an email recipient from a mailbox

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • mailbox_uuid

    • String

    • True

    The UUID of the Mailbox to be queried

  • • recipient_uuid

    • String

    • True

    The UUID of the Email Recipient to be deleted

  Response Details

  204 Response

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

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }