Voicemail module GraphQL
- Nathaniel Halbrooks
This wiki will capture the API's to enable and disable the voicemail for an extension.
Enable VoiceMail
To enable the voicemail service on a extension.
API: enableVoiceMail
API Parameter:
Name | Field | Type | Default | Description |
|---|---|---|---|---|
extensionid | Mandatory | String |
| Specify the extension to enable voicemail. |
password | Mandatory | String |
| Specify the password for the extension. |
name | Optional | String |
| Specify a name for voicemail. |
Optional | String |
| The email address for voicemail. | |
pager | Optional | String |
| Voice mail pager number. |
saycid | Optional | Boolean |
| Whether play caller ID to the caller. |
envelope | Optional | Boolean |
| Whether to play envelope to the caller. |
attach | Optional | Boolean |
| Whether to attach voicemail from local storage. |
delete | Optional | Boolean |
| Whether to delete voicemail from local storage. |
API Example:
Query Parameters
status
message |
API Request
mutation {
enableVoiceMail(input: {
extensionId: "202021"
password: "123456"
email: "test@gmail.com"
pager: "1234"
saycid: true
envelope: true
attach: true
delete: true
}) {
status message
}
} |
API Response
{
"data": {
"enableVoiceMail": {
"status": true,
"message": "Voicemail has been created successfully"
}
}
} |
Disable Voicemail
To disable the voicemail service to an extension.
API - disableVoiceMail
API Parameters -
Name | Field | Type | Default | Description |
|---|---|---|---|---|
extensionId | Mandatory | String |
| Specify the extension to disable voice mail. |
API Example -
Query Parameters
API Request
API Response
Fetch VoiceMail Extension
API - fetchVoiceMail
API Parameters:
Name | Field | Type | Default | Description |
|---|---|---|---|---|
extensionId | Mandatory | String |
| Specify the extension to fetch voice mail details. |
API Example -
Query Parameters
API Request
API Response