You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/api_documentation/signal_api/index.rst
+31-2Lines changed: 31 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,10 @@ Used to find the call associated with the signal.
58
58
59
59
or
60
60
61
+
`external_call_unique_id` The unique ID of the call from an external system.
62
+
63
+
or
64
+
61
65
`call_start_time` The start time does not have to be exact since clocks will not be perfectly synchronized. We will find the closest match (in combination with **duration_in_seconds**, if provided). See **Timestamp Formats** section below for descriptions of supported timestamps.
62
66
63
67
Note: If using **call_start_time** to match, instead of **transaction_id**, one or more of the following optional parameters is highly recommended. The optional parameters are ignored when using the **transaction_id**:
@@ -225,13 +229,13 @@ For example, if a **transaction_id** or **call_start_time** are not passed in th
225
229
{
226
230
"errors": {
227
231
"class": "InvalidInput",
228
-
"invalid_data": "transaction_id, call_record_id, or call_start_time must not be empty"
232
+
"invalid_data": "transaction_id, call_record_id, external_call_unique_id, or call_start_time must not be empty"
229
233
}
230
234
}
231
235
232
236
If there are multiple issues with the request, we will do our best to package all of the issues together in one response message.
233
237
234
-
**Example Bad Request**
238
+
**Example Bad Signal Request**
235
239
236
240
.. code-block:: json
237
241
@@ -275,6 +279,31 @@ If there are multiple issues with the request, we will do our best to package al
275
279
}
276
280
}
277
281
282
+
**Example Bad Custom Data Request**
283
+
284
+
.. code-block:: json
285
+
286
+
{
287
+
"search": {
288
+
"transaction_id": "0000000-0000000A"
289
+
},
290
+
"custom_data": {
291
+
"agent": "James Bond"
292
+
},
293
+
"oauth_token": "<YOUR OAUTH TOKEN>"
294
+
}
295
+
296
+
**Response (403 Forbidden):**
297
+
298
+
.. code-block:: json
299
+
300
+
{
301
+
"errors": {
302
+
"class": "InvalidInput",
303
+
"invalid_data": "'custom_data' must be an array of hashes"
0 commit comments