Missed Call Notifications

A Missed Call Notification is a configuration for sending email alerts when the specified User/Number misses a call

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/voip/missed-call

Gets all active Missed Call Notifications on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-03-24",
            "email_address" : "alerts@example.com",
            "include_voicemail_answered" : true,
            "updated_on" : "2023-03-24",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
            "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/missed-call/{uuid}

Gets a specific Missed Call Notification on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Missed Call Notification to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-24",
        "email_address" : "alerts@example.com",
        "include_voicemail_answered" : true,
        "updated_on" : "2023-03-24",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
        "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

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

404 Response

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

POST/voip/missed-call

Creates a new Missed Call Notification

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- email_address
- String
- True
The email address to send the notification to
- include_voicemail_answered
- boolean
- False
If true, will also send notifications for calls answered by the mailbox. Defaults to false
- voip_number_uuid
- String
- False
The UUID of the Number for this Missed Call Notification. Exactly one of voip_user_uuid and voip_number_uuid should be provided
- voip_user_uuid
- String
- False
The UUID of the User for this Missed Call Notification. Exactly one of voip_user_uuid and voip_number_uuid should be provided

JSON all-fields example:

{
    "email_address" : "alerts@example.com",
    "include_voicemail_answered" : true,
    "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
    "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-03-24",
        "email_address" : "alerts@example.com",
        "include_voicemail_answered" : true,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
        "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

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

404 Response

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

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

POST/voip/missed-call/{uuid}

Updates a specific Missed Call Notification
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Missed Call Notification to be updated
POST body
- Name
- Type
- Required
- email_address
  
  String
  
  True
  
  The email address to send the notification to
- include_voicemail_answered
  
  boolean
  
  False
  
  If true, will also send notifications for calls answered by the mailbox. Defaults to false
- voip_number_uuid
  
  String
  
  False
  
  The UUID of the Number for this Missed Call Notification. Exactly one of voip_user_uuid and voip_number_uuid should be provided
- voip_user_uuid
  
  String
  
  False
  
  The UUID of the User for this Missed Call Notification. Exactly one of voip_user_uuid and voip_number_uuid should be provided
JSON all-fields example:
{ "email_address" : "alerts@example.com", "include_voicemail_answered" : true, "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb", "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa" }
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2023-03-24",
        "email_address" : "alerts@example.com",
        "include_voicemail_answered" : true,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "voip_number_uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
        "voip_user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
DELETE/voip/missed-call/{uuid}

Deletes a specific Missed Call Notification
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Missed Call Notification to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```