Conversation

Get Telegram Bot channel information

Returns the information for a Telegram Bot channel linked to a Conversation API App.
get/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

conversationAppIdstring required

The unique ID of the app. You can find this on the <a href="https://dashboard.sinch.com/convapi/apps">Sinch Dashboard</a>.

Response

Telegram Bot information.

status'ACTIVE' | 'ERROR' | 'FAILING' | 'PENDING' | 'UNRECOGNIZED' required

Channel integration status.

statusDescriptionstring

Channel integration description if status is ERROR or FAILED.

namestring

Name of the bot.

usernamestring

Username of the bot.

canJoinGroupsboolean

If the bot can be invited to groups.

canReadAllGroupMessagesboolean

If <a href="https://core.telegram.org/bots#privacy-mode">privacy mode</a> is disabled for the bot.

supportsInlineQueriesboolean

If the bot supports inline queries.

Changes

Changed in 2 of the 4 revisions of this API.525

  • c6a937922d10524See the full diff
    • the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 404

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • removed subschema #1: ConversationAppNotFoundErrorTitle subschema #2: ConversationAppNoTelegramChannelErrorTitle from the response body oneOf list for the response status 404

      response-body-one-of-removed

    • removed subschema #1: TelegramApiErrorErrorTitle subschema #2: InternalErrorErrorTitle from the response body oneOf list for the response status 500

      response-body-one-of-removed

    • added the optional property additionalInformation to the response with the 400 status

      response-optional-property-added

    • added the optional property additionalInformation to the response with the 401 status

      response-optional-property-added

    • added the optional property additionalInformation to the response with the 404 status

      response-optional-property-added

    • added the optional property additionalInformation to the response with the 500 status

      response-optional-property-added

    • added ConversationChannelStatusEnum to the status response property allOf list for the response status 200

      response-property-all-of-added

    • the response property errorCode became required for the status 400

      response-property-became-required

    • the response property errorCode became required for the status 401

      response-property-became-required

    • the response property message became required for the status 400

      response-property-became-required

    • the response property message became required for the status 401

      response-property-became-required

    • the response property resolution became required for the status 400

      response-property-became-required

    • the response property resolution became required for the status 401

      response-property-became-required

    • removed the ACTIVE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the ERROR enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the FAILING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the PENDING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the UNRECOGNIZED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • added the required property errorCode to the response with the 404 status

      response-required-property-added

    • added the required property errorCode to the response with the 500 status

      response-required-property-added

    • added the required property message to the response with the 404 status

      response-required-property-added

    • added the required property message to the response with the 500 status

      response-required-property-added

    • added the required property resolution to the response with the 404 status

      response-required-property-added

    • added the required property resolution to the response with the 500 status

      response-required-property-added

    • api operation id TelegramController_get_v1 removed and replaced with ConversationTelegramController_get_v1

      api-operation-id-removed

Of the 4 revisions, 1 has no diff computed.