Messenger

Get channel

Get channel by channel id.

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
channelId
required
string

Channel identifier used to retrieve channel.

Responses
200

Successfully retrieved channel.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

404

Returned when a client requests an resource that is not found

500

Returned when an error occurs on the server

get/v1/channels/{channelId}
Response samples
application/json
{
  • "arn": "string",
  • "state": "string"
}

Translate text

Translate text by providing text and target language.

SecurityOAuth2 or JifelineAuthorizer
Request
Request Body schema: application/json
required

Messages to translate

required
object

Message with the original text and the translated text.

target_language
required
string

Target language of the translation.

Responses
201

Successfully translated text.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v1/translate
Request samples
application/json
{
  • "message": {
    },
  • "target_language": "de"
}
Response samples
application/json
{
  • "message": {
    },
  • "target_language": "de",
  • "source_language": "en"
}

Options

Enable CORS by returning correct headers

SecurityNone
Request
path Parameters
channelId
required
string

Channel identifier used to retrieve channel.

Responses
200

Enable CORS by returning correct headers

options/v1/channels/{channelId}/actions/send-control-message

Send control message

Sending a control message which will trigger a ping over the websockets.

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
channelId
required
string

Channel identifier used to retrieve channel.

Responses
200

Successfully send control request.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v1/channels/{channelId}/actions/send-control-message
Response samples
application/json
{
  • "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459"
}

create channel attachment

Create channel attachment for a channel. Presigned url in response can be used to upload attachment.

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
channel_id
required
string

Channel identifier used to retrieve attachments.

Request Body schema: application/json
required

Create channel attachment

file_name
string

Filename of the attachment.

Responses
201

Successfully created channel attachment.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v1/channel-attachments
Request samples
application/json
{
  • "file_name": "file.txt"
}
Response samples
application/json
{
  • "file_name": "file.txt",
  • "signed_url": "http://example.com",
  • "file_reference": "/channel/abcb2f39-7620-401a-8dab-ec2f6075ed8a/abcb2f39-7620-401a-8dab-ec2f6075ed8a/file.txt"
}

get channel attachments

Get attachments for a channel.

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
channel_id
required
string

Channel identifier used to retrieve attachments.

file_reference
required
string

File refrence used to retrieve attachments. This is returned in response of create channel attachment. Or can be found in message in a chat.

Responses
200

Successfully retrieved channel attachment.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/channel-attachments
Response samples
application/json
{
  • "file_name": "file.txt",
  • "signed_url": "http://example.com",
  • "file_reference": "/channel/abcb2f39-7620-401a-8dab-ec2f6075ed8a/abcb2f39-7620-401a-8dab-ec2f6075ed8a/file.txt"
}