Chat / Platform API

Overview
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - Get a user
- - Creating users
  - Create a user
- - Managing users
  - Update a user
  - Delete a user
- - Managing session tokens
  - Issue a session token
  - Revoke all session tokens
- - Managing joined group channels
  - List group channels by user
  - Leave group channels
- - Getting group channel count
  - Get number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - Get an open channel
  - List group channels
  - Get a group channel
- - Creating a channel
  - Create an open channel
  - Create a group channel
- - Inviting a user
  - Invite as members
  - Accept an invitation
  - Decline an invitation
- - Managing metacounter
  - Get metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- - Managing typing indicators
  - Start typing indicators
  - Stop typing indicators
- Application
- Overview
- - Setting up an application
  - Get global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - Get a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Get an IP whitelist
  - Add an IP to a whitelist
  - Delete IPs from a whitelist
- - Managing auto event messages
  - List auto event messages
  - Configure auto event message settings
- - Understanding rate limits
  - Rate limits
- - Getting failed webhooks
  - Get failed webhooks
- Organization
- Overview
- - Managing application
  - List applications
  - Get an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - Get a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- Statistics
- Overview
- - Advanced analytics
  - Get advanced analytics metrics
- - Concurrent connections
  - Get number of concurrent connections
- - DAUs & MAUs
  - Get number of daily active users
  - Get number of monthly active users
- - Peak connections
  - Get number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - Get a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - Get a bot
- - Creating a bot
  - Create a bot
- - Sending a bot message
  - Send a bot message
- - Managing a bot
  - Update a bot
  - Join channels
  - Leave channels
  - Delete a bot
- Report
- Overview
- - Creating a report
  - Report a user
  - Report a channel
  - Report a message
- Webhook
- Overview
- - Managing subscribed events
  - Get a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - Get a GDPR request
- - Creating a GDPR request
  - Register a GDPR request
- - Managing GDPR requests
  - Cancel the registration of a GDPR request
Deprecated
Error codes

Chat Platform API v3

Chat Platform API

Chat

Platform API

Version 3

Home

/

Chat

/

Platform API

/

Application

Get a push configuration

Retrieves a specific push configuration of an application. The type of a push configuration is either fcm, huawei, or apns.

HTTP request

GET https://api-{application_id}.sendbird.com/v3/applications/push/{push_type}/{provider_id}

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
push_type	string	Specifies the type of the push configuration. Acceptable values are fcm for FCM, huawei for HMS, and apns for APNs.
provider_id	string	Specifies the provider ID of the push configuration.

Response

If successful, this action returns information on a push configuration in the response body.

FCMHMSAPNs

# Status: 200 OK
{
    "push_configurations": [
        {
            "id": "fbdd6d0071217ac71b5d8acab65d615cfab3f7b1",
            "push_type": "FCM",
            "created_at": 1596607063,
            "api_key": "BBBBEEuCTTE:APA91bE8HPMm-xQa5RT4RaPXi-UdmGNfjDUAaFRryNbth7k4uLZGK9TufYqZXLBf82I3DHyH-L5QlNef1t60WxocozV3uWIRQkESW69XgKyrRQEBH8vKlE9C5rkDtUJDFavEgFmiICvw",
            "sender_id": "69982227377",
            "push_sound": "ring.swf"
        }
    ]
}

List of response properties

Property name	Type	Description
push_configurations[]	array of objects	A list of either FCM, HMS, or APNs push configurations.

In the case of an error, an error object is returned. A detailed list of error codes is available here.

Try API requests