API used to create a FindMe
Use the FindMe Create API to create a FindMe
Use the FindMe Create API to create a FindMe within a DialogTech's account.
Base URL for FindMe Create
Parameter List
Parameter | Required | Accepts | Max Length | Notes | Usage |
---|---|---|---|---|---|
action | Yes | String: findme.create | n/a | Only accepts findme.create to create a FindMe | Defines the API Call as "FindMe Create" type |
access_key | Yes | String | n/a | Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
secret_access_key | Yes | String | n/a | Secret Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
name | Yes | String | n/a | Names the FindMe | Defines the name of the FindMe |
list_type | No | 1 or 2 | 6 | 1 - Individual FindMe (Default) 2 - Customer Service Hunt Group | Modifies the FindMe default audio prompts to use verbiage similar to calling a single individual (Individual FindMe), or any individual in a group (Customer Service Hunt Group) |
loop_count | No | String | 1 | Accepts values 0 to 5 (default is 1) | Determines the total number of times the predefined list of numbers would be attempted in its entirety before moving to the no answer action |
distribution_type | No | 1 or 2 | 1 | value not present on URL - Attempt the list sequentially on each call (default) 1 - Randomized order 2 - Round robin order | Determines if the predefined list of numbers should be attempted in round-robin order or randomly. |
record | No | 1 or 2 | 1 | 0 - Do not record the call (default) 1 - Record the call | Determines if the call will be recorded or not. |
screen_method | No | 0 or 1 or 2 | 1 | 0 - Record the caller's name (default) 1 - Whisper the whisper_phrase value using text-to-speech2 - Whisper the audio file provided via whisper_audio (note: The audio file must be an existing audio file within the account) | Determines how the caller will be screened prior to being connected |
screen_prompt | No | String | n/a | Default is a standardized pre-recorded prompt provided by DialogTech | Determines the screen message played when screen_method=0 |
dtmf_only | No | 0 or 1 | 1 | 0 - Accept voice input as well as keypress input on call-acceptance prompts 1 - Only accept keypress input on call-acceptance prompts | Determines how the user receiving the call can accept the call, 0 allows the user to say Yes or press 1 to accept a call. 1 requires the user to press 1 to accept the call. |
holdmusic | No | String | n/a | Default is a standardized pre-recorded prompt provided by DialogTech (note: The audio file must be an existing audio file within the FindMe directory in the account) | Audio file to play to caller as caller waits for destination to answer. . |
holdrepeat | No | 0 or 1 or 2 | 1 | 0 - Play once per FindMe session 1 - Play once between attempts 2 - Play continuously between attempts | Determines how often the hold message is played to the caller |
timeout | No | 10-60 | 2 | Default is 30 | Number of seconds to ring each destination before determining that attempt is not answered, and moving to the next number or action |
whisper_phrase | No | String | n/a | To be used with screen_method (default is no phrase) | Phrase spoken to person who answers phone |
whisper_audio | No | String | n/a | To be used with screen_method | The name of an audio file in your Whisper Phrase Audio files folder |
findme_action | No | String | n/a | See FindMe Action Table Below | Determines which application a call is sent to after it is determined that no numbers in the FindMe list have accepted the call. |
findme_action_parameter | No | String | n/a | See FindMe Action Table Below | Building Block ID associated with the findme_action |
advanced_audio_id | No | String | n/a | Please call our Customer Support Team to help retrieve the appropriate value if you would like to use a custom audio-prompt set. | If there is already a configured Advanced Audio Prompt Set in another FindMe you can use that set ID here to use the same audio-prompt set |
numbers | No | String | n/a | csv list of unformatted numbers *(ex: 5556667777,5553331234) | Phone numbers to add to the Find Me. Can either be a single number or a comma-separated list of numbers. |
auto_accept | No | String | n/a | 0 - Agent will be prompted to accept the call (note: can be used with dtmf_only to require a keypress to accept the call)1 - The first number that answers, receives the call without any option to accept/deny the call 2 - The last number attempted will be sent the call. Call screening will be disabled if transferred in this way. 3 - The last number attempted will be sent the call. Call screening will remain enabled if transferred in this way. | Determines how the recipient of the call will be prompted (or not) to accept the call |
simul | No | String | n/a | The maximum value will be determined by the account type, and the number of available Simultaneous FindMe Ports are available with the account | Determines the number of simultaneous calls to make to the various numbers in the FindMe list. |
Using this API
These code examples are meant to show a basic method of accessing DialogTech's FindMe Create API.
curl -X ""
Example Response
<response>
<result>success</result>
<result_description></result_description>
<findme_id>12345</findme_id>
</response>