Follow Structure
Base Attributes
| Attribute | Type | Example |
|---|---|---|
|
id The ID of the follow |
Integer | 1 |
|
name The name of the follow |
String | Main Fax |
|
noanswer_destination_id The ID of the no answer destintion |
Integer | |
|
noanswer_destination_type The type of the no answer destination |
String | |
|
callee_prompt_file_id The ID of the audio file to use as the initial audio prompt |
Integer | |
|
callee_options_prompt_file_id The ID of the audio file to be played to the callee instead of the default options |
Integer | |
|
caller_prompt_file_id The ID of the audio file audio file to play to the caller before connecting the call |
Integer | |
|
play_ringing Playing ringing rather than music on hold |
Boolean | false |
Extended Attributes
| Attribute | Type | Example |
|---|---|---|
|
created_at The time the follow was created |
Time | |
|
updated_at The time the follow was updated |
Time |
Expansions
Expansions are embedded structures of other objects that are related to the structure that you're viewing. Which expansions are returned by a specific action are shown on that action's documentation however some actions allow you to choose which expansions are returned.
| Attribute | Type | Example |
|---|---|---|
|
numbers The numbers dialled by this follow |
Array | |
|
noanswer_destination The associated no answer destination |
Hash | |
|
callee_prompt_file The associated callee prompt audio file |
Hash | |
|
callee_options_prompt_file The associated callee options prompt audio file |
Hash | |
|
caller_prompt_file The associated caller prompt audio file |
Hash |