Plum Insight Documentation
api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
api [2018/05/02 15:48]
admin
api [2018/05/02 15:48] (current)
admin
Line 147: Line 147:
 **Request Parameters**:​ \\ **Request Parameters**:​ \\
 |Name|Data Type|Required|Description| |Name|Data Type|Required|Description|
-|phone_number|string|yes|The phone number to which the outbound call should be placed. There are multiple ways to format phone numbers. They can include the '​tel:'​ prefix. ANI and postd suffixes are also valid, e.g. ani=1234567890 and/or postd=1234. Examples of valid numbers include: 6175551234, tel:​+16175551234,​ tel:​16175551234;​ani=2125551234 (this determines the number the recipient sees), tel:​16175551234;​ani=5555555555;postd=2 (this determines the number the recipient sees and enters the dtmf tone "​2"​ after the call connects).|+|phone_number|string|yes|The phone number to which the outbound call should be placed. There are multiple ways to format phone numbers. They can include the '​tel:'​ prefix. ANI and postd suffixes are also valid, e.g. ani=1234567890 and/or postd=1234. Examples of valid numbers include: 6175551234, tel:​+16175551234,​ tel:​16175551234;​ani=2125551234 (this determines the number the recipient sees), tel:​16175551234;​ani=2125551234;postd=2 (this determines the number the recipient sees and enters the dtmf tone "​2"​ after the call connects).|
 |start_timestamp|string|no|Unix timestamp for when to make the outbound call| |start_timestamp|string|no|Unix timestamp for when to make the outbound call|
 |end_timestamp|string|no|Unix timestamp for when to stop attempting to make the outbound call| |end_timestamp|string|no|Unix timestamp for when to stop attempting to make the outbound call|
api.txt · Last modified: 2018/05/02 15:48 by admin