API & DOCS

My Account            

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

https://secure.dialogtech.com/ibp_api.php

Parameter List

ParameterRequiredAcceptsMax LengthNotesUsage
actionYesString: findme.createn/aOnly accepts findme.create to create a FindMeDefines the API Call as "FindMe Create" type
access_keyYesStringn/aAccess Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
secret_access_keyYesStringn/aSecret Access Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
nameYesStringn/aNames the FindMeDefines the name of the FindMe
list_typeNo1 or 261 - 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_countNoString1Accepts 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_typeNo1 or 21value 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.
recordNo1 or 210 - Do not record the call (default)
1 - Record the call
Determines if the call will be recorded or not.
screen_methodNo0 or 1 or 210 - Record the caller's name (default)
1 - Whisper the whisper_phrase value using text-to-speech
2 - 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_promptNoStringn/aDefault is a standardized pre-recorded prompt provided by DialogTechDetermines the screen message played when screen_method=0
dtmf_onlyNo0 or 110 - 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.
holdmusicNoStringn/aDefault 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. .
holdrepeatNo0 or 1 or 210 - 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
timeoutNo10-602Default is 30Number of seconds to ring each destination before determining that attempt is not answered, and moving to the next number or action
whisper_phraseNoStringn/aTo be used with screen_method (default is no phrase)Phrase spoken to person who answers phone
whisper_audioNoStringn/aTo be used with screen_methodThe name of an audio file in your Whisper Phrase Audio files folder
findme_actionNoStringn/aSee FindMe Action Table BelowDetermines which application a call is sent to after it is determined that no numbers in the FindMe list have accepted the call.
findme_action_parameterNoStringn/aSee FindMe Action Table BelowBuilding Block ID associated with the findme_action
advanced_audio_idNoStringn/aPlease 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
numbersNoStringn/acsv 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_acceptNoStringn/a0 - 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
simulNoStringn/aThe maximum value will be determined by the account type, and the number of available Simultaneous FindMe Ports are available with the accountDetermines 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>