SIsinch
Conversation

Get Telegram Bot channel information

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

Request

  • Base URL
    https://provisioning.api.sinch.com
  • URL
    https://provisioning.api.sinch.com/v1/projects/{projectId}/conversation/apps/{conversationAppId}/telegram
  • Auth
    HTTP basic and HTTP bearer and OAuth 2
    Client credentials
    Token URL: https://auth.sinch.com/oauth2/token

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

  • c6a937922d10Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from string to no type for status

    • info

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

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • c78a716de420Revision changes
    • info

      api operation id TelegramController_get_v1 removed and replaced with ConversationTelegramController_get_v1