Find Sessions

GET 
/api/v2/instance/:instanceId/typebot-integration/session

Find sessions by keyRemoteJid and status

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

status string

Possible values: [open, close, pause, resume]

Status

keyRemoteJid string

Key Remote Jid

Responses

200

Success - status: 200

application/json

Schema

Schema

sessionId stringrequired
keyRemoteJid stringrequired
status stringrequired
typebotIntegrationId stringrequired

Example (from schema)

{
  "sessionId": "string",
  "keyRemoteJid": "string",
  "status": "string",
  "typebotIntegrationId": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

403

ForbiddenException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...