These are the steps to figure out what call information is required for an account and pin
Step 1: Get PIN ID
Make a POST request to the Search Pins endpoint with the following parameters.
Request Parameters
filter:"\"pin\": pin, \"accountno\": accountNo
Sample Response 200 OK
[{
"account-id": 29,
"additional-party": true,
"can-specify-gender": true,
"clamping-disabled": false,
"comment": null,
"customer-conf-connect": true,
"customer-conf-disconnect": true,
"customer-conf-enabled": true,
"customer-conf-setup": true,
"customer-conf-transfer": true,
"description": "Quick PIN 6002",
"enable-intl-dialing": true,
"enabled": true,
"express-language-menu-id": 0,
"express-language-menu-name": "'",
"hold-type": "Music",
"hold-type-id": 2,
"id": 226,
"inventory-no": "",
"language-selection": "Normal",
"language-selection-id": 2,
"modified-by": "cbrown@cyracomdev.com",
"modified-date": "2023-02-22T02:14:01.515271Z",
"pin": "6002",
"play-instructions": true,
"priority": true,
"session-data-list": "Add Party Normal",
"session-data-optional": "Add Party Normal",
"session-data-required": "",
"speech-recognition": true,
"survey": "",
"survey-id": 0,
"suspended": false,
"suspension-reason": "",
"suspension-reason-id": 0,
"tags": "",
"video-rollover": true
}]
Step 2: Get Session Data Configurations
Make a GET request to the Get Session Data Configurations endpoint with the pin-id.
Request Parameters
pin-id: The id of the pin returned in step 1
Return Parameters
configuration-required: If set to true, the following information must be in the call information.call-information-id: Must match theidfield in the call information.call-information-name: Must match the name field in the call information.char-limit: The length ofvaluefield in the call information must be less than or equal tochar-limit.
Sample Response 200 OK
[{
"allow-char-override": false,
"call-information-description": "NYCHHC Clinical Call",
"call-information-id": 46,
"call-information-name": "Clinical Call",
"char-limit": 10,
"configuration-required": true,
"default-char-limit": 1,
"editable": true,
"enable-opt-out": true,
"enabled": true,
"id": 171,
"modified-by": "cbrown@cyracomdev.com",
"modified-date": "2023-02-22T02:12:19.0438574Z",
"pin-id": 203,
"requires-assistance": false,
"session-data-collection": "Clinical Call - No/Opt",
"session-data-collection-id": 161,
"session-data-configuration-order": 1,
"session-data-validation-id": 0,
"speech-available": true
},{
"allow-char-override": false,
"call-information-description": "Phone Number to call for an addtional party call.",
"call-information-id": 4,
"call-information-name": "Addtional Party Phone Number",
"char-limit": 20,
"configuration-required": false,
"default-char-limit": 20,
"editable": true,
"enable-opt-out": true,
"enabled": true,
"id": 170,
"modified-by": "cbrown@cyracomdev.com",
"modified-date": "2023-02-22T02:12:17.5438287Z",
"pin-id": 203,
"requires-assistance": false,
"session-data-collection": "Add Party Normal",
"session-data-collection-id": 5,
"session-data-configuration-order": 0,
"session-data-validation-id": 0,
"speech-available": true
}]
Step 3: Start or Register the Call
Using the data collected in the previous steps, make a POST request to start a telehealth call or register the call.
The "information" field will need to include information corresponding to the data retrieved in Step 2. For each configuration where "configuration-required" is true, the "information" field will require an entry with information that maps to the configuration as follows:
The
"id"in the"information"will need to match the"call-information-id"from the returned required configuration.The
"name"in the"information"will need to match the"call-information-name"from the returned required configuration.The
"value"in the"information"will need to be less than or equal to the"char-limit"from the returned required configuration.
For example:
"information": [{
"id": {call-information-id},
"name": {call-information-name},
"value": {call-information-description}
}