Create a follow
This action will create a new follow and return its information
Try this request in your browser
URL
https://connectapi.dial9.co.uk/api/v2/follows/create
Access
Must be authenticated as a user or API token.
If not authorised, a AccessDenied
error will be returned.
Parameters
Parameter | Type | Default |
---|---|---|
unit_id The ID of the unit |
Integer | null |
name The name of the follow |
String | null |
noanswer_destination_id The ID of the no answer destintion |
Integer | null |
noanswer_destination_type The type of the no answer destination |
String | null |
play_ringing Playing ringing rather than music on hold |
Boolean | null |
callee_prompt_file_id The ID of the audio file to use as the callee prompt audio file |
Integer | null |
callee_options_prompt_file_id The ID of the audio file to use as the callee options prompt audio file |
Integer | null |
caller_prompt_file_id The ID of the audio file to use as the caller prompt audio file |
Integer | null |
numbers Numbers to include in this follow |
Array | null |
Errors
Error | Attributes |
---|---|
UnitNotFound The given unit was not found |
|
InvalidCalleePromptFile The callee prompt audio file ID is invalid |
|
InvalidCalleeOptionsPromptFile The callee options prompt audio file ID is invalid |
|
InvalidCallerPromptFile The caller prompt audio file ID is invalid |
|
ValidationError A validation error occurred |
|
Response Data
This action will return a follow structure.
You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.