Skip to content

Commit c5fa739

Browse files
authored
Merge pull request #412 from Invoca/JETS-382_update_signal_api_external_call_unique_id
JETS-382: Add external_call_unique_id callouts to Signal API doc
2 parents 3bb8f68 + 7739bb5 commit c5fa739

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

source/api_documentation/signal_api/index.rst

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ Used to find the call associated with the signal.
5858

5959
or
6060

61+
`external_call_unique_id` The unique ID of the call from an external system.
62+
63+
or
64+
6165
`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.
6266

6367
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
225229
{
226230
"errors": {
227231
"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"
229233
}
230234
}
231235
232236
If there are multiple issues with the request, we will do our best to package all of the issues together in one response message.
233237

234-
**Example Bad Request**
238+
**Example Bad Signal Request**
235239

236240
.. code-block:: json
237241
@@ -275,6 +279,31 @@ If there are multiple issues with the request, we will do our best to package al
275279
}
276280
}
277281
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"
304+
}
305+
}
306+
278307
-----
279308

280309
**Record Invalid Error**

0 commit comments

Comments
 (0)