Recherche filtrée

GET

/relation-tiers/v1/interactions:search

const url = 'https://example.com/relation-tiers/v1/interactions:search?direction=INBOUND';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/relation-tiers/v1/interactions:search?direction=INBOUND' \
  --header 'Authorization: Bearer <token>'

Autorisations

authentification
relation-tiers:consultation

Paramètres

Paramètres (header)

X-Tenant-Id

string

Facultatif — le tenant fait foi dans le jeton ; s’il est fourni, il doit être identique, et le corps ne peut jamais le choisir.

X-Correlation-Id

string

Paramètres (query)

cursor

string

limit

integer

<= 200

actorId

string

channel

string

direction

string

Allowed values: INBOUND OUTBOUND INTERNAL

businessFrom

string format: date-time

businessTo

string format: date-time

Réponses

200

La page d’échanges.

application/json

object

items

required

Array<object>

object

interactionId

required

string

direction

required

string

Allowed values: INBOUND OUTBOUND INTERNAL

channel

required

string

businessAt

required

string format: date-time

recordedAt

string format: date-time

participants

Array<object>

object

contentRef

string

corrections

Array<string>

nextCursor

string

Example

{
  "items": [
    {
      "direction": "INBOUND"
    }
  ]
}

401

Aucune identité présentée (401).

403

L’identité présentée n’a pas la famille d’accès requise (403). Les 403 croisés entre familles sont prouvés par les tests d’assemblage. Un écart de tenant sur une ressource produit 404 (ne rien révéler), jamais ce code.