Match-interaction

This service will do the following for ALL Services:

• It looks through all the services for one that matches the input criteria.
• Only the service id (session id) and data id will be returned to the requester by default. Since 8.5.102, to retrieve user data, you can set the _return_user_data option to true in your query.
• The matched service access information will be unreserved (access resources returned).

Important

The user of this service can use the Storage APIs to retrieve any data that was associated with the matched service.

Create Request Data

These are the service specific parameters that will be supplied on the Create service API.

Parameters	Mandatory	Description
_phone_number	No	This is the phone number of the party that is calling and will be matched against the _phone_number property of the services.
_access_number	Yes	This is the number that the party called and will be matched against the _access_number property associated with the services.
_access_code	No	This is the code assigned to the party that is calling will be matched against the _access_code property assigned to the services.
_return_multiple_matches [since 8.5.102]	No	Set this option to true to retrieve an array of matching results in the JSON response in the following format: { "matches" : [ { _id...}, { _id...} ] }
_return_data [since 8.5.102]	No	Set this option to true to retrieve the user data instead of data_id only; false by default.
_delete_service [since 8.5.102]	No	Set this option to true to delete the service; false by default. Note that, in any case, GMS releses the _access_number and _access_code resources.

Create Response Data

Parameters	Mandatory	Description
_id	Yes	Identifier of the matching service.
_data_id	Yes	Identifier of the matching service's data that is in GMS Storage.
user_data [since 8.5.102]	No	User Data attached to service, if you set the _return_user_data option to true.

Specific Requests

There are no specific requests for this service.

Events

There are no events associated with this service.

Configuration

The following are the configuration options that you can access or modify in the Mobile Engagement UI:

Option	Description
_type = builtin	For Genesys Mobile Services-based services: builtin For Orchestration Server-based services: ors
_service = match-interaction	For Genesys Mobile Services-based services: The name of the matching service. For Orchestration Server-based services: The URL of the service's SCXML application. Other SCXML Callback services: The URL of the service's SCXML callback application. In that case, you must set _service_type to callback.
_phone_number	Note: Request parameter. Number of the mobile phone where the service request originated.
_access_code	Access code returned as a result of request-access. Note: Request parameter.
_access_number	Number that the customer called. Note: Request parameter.