Skip to main content
API docs by Redocly

Reecall API (0.2.10)

Download OpenAPI specification:Download

Agent

GET Agent

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Agent

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
settings
object
setup
Array of objects
personalityId
string
sentences
object
variables
object
referee
object
scenarios
object
companyId
string
partnerId
string
templateId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "templateId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "templateId": "string",
  • "id": "string"
}

GET Agent

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "templateId": "string",
  • "id": "string"
}

PATCH Agent

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
name
required
string
settings
object
setup
Array of objects
personalityId
string
sentences
object
variables
object
referee
object
scenarios
object
companyId
string
partnerId
string
templateId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "templateId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "templateId": "string",
  • "id": "string"
}

DELETE Agent

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "settings": { },
  • "setup": [
    ],
  • "personalityId": "string",
  • "sentences": { },
  • "variables": { },
  • "referee": { },
  • "scenarios": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "templateId": "string",
  • "id": "string"
}

AgentList

GET AgentList

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST AgentList

Authorizations:
bearer
Request Body schema: application/json
required
name
string
templateIds
Array of strings
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET AgentList

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH AgentList

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
name
string
templateIds
Array of strings
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE AgentList

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "templateIds": [
    ],
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Channel

GET Channel

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Channel

Authorizations:
bearer
Request Body schema: application/json
required
agentId
string
typology
string
type
string
name
string
config
object
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET Channel

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH Channel

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
agentId
string
typology
string
type
string
name
string
config
object
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE Channel

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "typology": "string",
  • "type": "string",
  • "name": "string",
  • "config": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Company

GET Company

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Company

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET Company

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

GET Company

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH Company

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
name
required
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE Company

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

CompanySetting

GET CompanySetting

Authorizations:
bearer
path Parameters
companyId
any
key
any

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "id": "string"
}

POST CompanySetting

Authorizations:
bearer
path Parameters
companyId
any
key
any
Request Body schema: application/json
required
key
required
string
value
required
string
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "id": "string"
}

GET CompanySetting

Authorizations:
bearer
path Parameters
companyId
any

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "companyId": "string",
  • "partnerId": "string",
  • "id": "string"
}

Contact

GET Contact

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Contact

Authorizations:
bearer
Request Body schema: application/json
required
phone
string
email
string
lastName
string
firstName
string
tagIds
Array of strings
meta
object
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

GET Contact

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

PATCH Contact

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
phone
string
email
string
lastName
string
firstName
string
tagIds
Array of strings
meta
object
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

DELETE Contact

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "phone": "string",
  • "email": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "tagIds": [
    ],
  • "meta": { },
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

Conversation

GET Conversation

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Conversation

Authorizations:
bearer
Request Body schema: application/json
required
agentId
string
channelId
string
contactId
string
tagIds
Array of strings
messages
Array of objects
events
Array of objects
scenarioPlayed
Array of strings
collectedData
Array of objects
relatedRessources
Array of objects
audioUrl
string
communicationId
string
duration
number
transferDuration
number
missed
boolean
title
string
status
string
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

GET Conversation

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

PATCH Conversation

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
agentId
string
channelId
string
contactId
string
tagIds
Array of strings
messages
Array of objects
events
Array of objects
scenarioPlayed
Array of strings
collectedData
Array of objects
relatedRessources
Array of objects
audioUrl
string
communicationId
string
duration
number
transferDuration
number
missed
boolean
title
string
status
string
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

DELETE Conversation

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "agentId": "string",
  • "channelId": "string",
  • "contactId": "string",
  • "tagIds": [
    ],
  • "messages": [
    ],
  • "events": [
    ],
  • "scenarioPlayed": [
    ],
  • "collectedData": [
    ],
  • "relatedRessources": [
    ],
  • "audioUrl": "string",
  • "communicationId": "string",
  • "duration": 0,
  • "transferDuration": 0,
  • "missed": true,
  • "title": "string",
  • "status": "string",
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "history": [
    ],
  • "lastHistoryUpdateId": 0,
  • "id": "string"
}

Hook

GET Hook

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Hook

Authorizations:
bearer
Request Body schema: application/json
required
name
string
steps
Array of objects
events
required
Array of strings
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET Hook

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH Hook

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
name
string
steps
Array of objects
events
required
Array of strings
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE Hook

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "steps": [
    ],
  • "events": [
    ],
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Info

GET Info

Authorizations:
bearer
query Parameters
group
any
level
any

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

GET Info

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Member

GET Member

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET Member

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "auth0Id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "role": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH Member

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
auth0Id
required
string
firstName
string
lastName
string
email
string
role
string

Responses

Request samples

Content type
application/json
{
  • "auth0Id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "auth0Id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "role": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE Member

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "auth0Id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "role": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

MemberSetting

GET MemberSetting

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST MemberSetting

Authorizations:
bearer
Request Body schema: application/json
required
memberId
required
string
key
required
string
value
required
object

Responses

Request samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET MemberSetting

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH MemberSetting

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
memberId
required
string
key
required
string
value
required
object

Responses

Request samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE MemberSetting

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "memberId": "string",
  • "key": "string",
  • "value": { },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Partner

GET Partner

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET Partner

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PartnerSetting

GET PartnerSetting

Authorizations:
bearer
path Parameters
partnerId
any
key
any

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "id": "string"
}

POST PartnerSetting

Authorizations:
bearer
path Parameters
partnerId
any
key
any
Request Body schema: application/json
required
key
required
string
value
required
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "id": "string"
}

GET PartnerSetting

Authorizations:
bearer
path Parameters
partnerId
any

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "partnerId": "string",
  • "id": "string"
}

Personality

GET Personality

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET Personality

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "language": "string",
  • "provider": "string",
  • "voice": "string",
  • "gender": "string",
  • "speed": 0,
  • "status": "string",
  • "pitch": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PhoneNumber

GET PhoneNumber

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET PhoneNumber

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "partnerId": "string",
  • "bundleId": "string",
  • "twilioId": "string",
  • "phone": "string",
  • "available": true,
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Tag

GET Tag

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

POST Tag

Authorizations:
bearer
Request Body schema: application/json
required
name
required
string
parentTagId
string
description
string
intentionTitle
string
color
string
isSmart
boolean
archived
boolean
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

GET Tag

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

PATCH Tag

Authorizations:
bearer
path Parameters
id
any
Request Body schema: application/json
required
name
required
string
parentTagId
string
description
string
intentionTitle
string
color
string
isSmart
boolean
archived
boolean
companyId
string
partnerId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

DELETE Tag

Authorizations:
bearer
path Parameters
id
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parentTagId": "string",
  • "description": "string",
  • "intentionTitle": "string",
  • "color": "string",
  • "isSmart": true,
  • "archived": true,
  • "companyId": "string",
  • "partnerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Template

GET Template

Authorizations:
bearer
query Parameters
filter
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET Template

Authorizations:
bearer
path Parameters
id
any
query Parameters
filter
any

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "template": { },
  • "partnerId": "string",
  • "isDeleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "string"
}