PushCredentials
Methods
AddPushCredential
Adds push credentials.
To call this method, make sure your service account has one of the following roles:
Parameters
push_provider_name:
string
The push provider name. The possible values are APPLE, APPLE_VOIP, GOOGLE, HUAWEI
push_provider_id:
number
The push provider id. Can be used instead of push_provider_name
application_id:
number
OptionalThe application id
application_name:
string
OptionalThe application name that can be used instead of application_id
credential_bundle:
string
OptionalThe bundle of Android/iOS/Huawei application
cert_content:
string
Public and private keys in PKCS12 format. Credentials for APPLE push
cert_file_name:
string
OptionalThe parameter is required, when set 'cert_content' as POST body. Credentials for APPLE push
cert_password:
string
The secret password for private key. Credentials for APPLE push
is_dev_mode:
boolean
Set true to use this certificate in apple's sandbox environment. Credentials for APPLE push
sender_id:
string
The sender id, provided by Google. Credentials for GOOGLE push
server_key:
string
The server key, provided by Google. Credentials for GOOGLE push
service_account_file:
string
The service account key file, provided by Google. Can be used instead of server_key. Credentials for GOOGLE push
huawei_client_id:
string
The client id, provided by Huawei. Credentials for HUAWEI push
huawei_client_secret:
string
The client secret, provided by Huawei. Credentials for HUAWEI push
huawei_application_id:
string
The application id, provided by Huawei. Credentials for HUAWEI push
Returns
result:
number
push_credential_id:
number
SetPushCredential
Modifies push credentials.
To call this method, make sure your service account has one of the following roles:
Parameters
push_credential_id:
number
The push credentials id
cert_content:
string
Public and private keys in PKCS12 format. Credentials for APPLE push
cert_password:
string
The secret password for private key. Credentials for APPLE push
is_dev_mode:
boolean
Set true to use this certificate in apple's sandbox environment. Credentials for APPLE push
sender_id:
string
The sender id, provided by Google. Credentials for GOOGLE push
server_key:
string
The server key, provided by Google. Credentials for GOOGLE push
service_account_file:
string
The service account key file, provided by Google. Can be used instead of server_key. Credentials for GOOGLE push
huawei_client_id:
string
The client id, provided by Huawei. Credentials for HUAWEI push
huawei_client_secret:
string
The client secret, provided by Huawei. Credentials for HUAWEI push
huawei_application_id:
string
The application id, provided by Huawei. Credentials for HUAWEI push
Returns
result:
number
DelPushCredential
Removes push credentials.
To call this method, make sure your service account has one of the following roles:
Parameters
push_credential_id:
number
The push credentials id
Returns
result:
number
GetPushCredential
Gets push credentials.
To call this method, make sure your service account has one of the following roles:
Parameters
push_credential_id:
number
OptionalThe push credentials id
push_provider_name:
string
OptionalThe push provider name. The possible values are APPLE, APPLE_VOIP, GOOGLE, HUAWEI
push_provider_id:
number
OptionalThe push provider id. Can be used instead of push_provider_name
application_name:
string
OptionalThe name of the bound application
application_id:
number
OptionalThe id of the bound application
with_cert:
boolean
OptionalSet true to get the user's certificate
Returns
result:
BindPushCredential
Binds push credentials to applications.
To call this method, make sure your service account has one of the following roles:
Parameters
push_credential_id:
intlist
The push credentials ID list separated by semicolon (;)
application_id:
intlist
The application ID list separated by semicolon (;). Use the 'all' value to select all applications
bind:
boolean
OptionalSet to false for unbind. Default value is true
Returns
result:
number