IOS Push
You need the Manage Settings permission to manage IOS Push.
IOS Push
- IOS Push Manage
GET livechat/iosPush
PUT livechat/iosPush
Model
IOS Push JSON Format
IOS Push is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
iosType |
string | Allowed values are "apns", "thirdParty". |
iosProductionCertificateFileName |
string | Name of ios production certificate file. |
iosProductionCertificateFileData |
file | Data of ios production certificate file. |
iosProductionCertificatePassword |
string | Password of ios production certificate file. |
iosDevelopmentCertificateFileName |
string | Name of ios development certificate file. |
iosDevelopmentCertificateFileData |
file | Data of ios development certificate file. |
iosDevelopmentCertificatePassword |
string | Password of ios development certificate file. |
iosAPNSPayloadFormat |
string | Format of ios APNS payload, mandatory when iosType is thirdParty.You can pass both plaintext and base64 encode text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
iosThirdPartyURL |
string | Ios third party URL, mandatory when iosType is thirdParty. |
iosThirdPartyRequestBody |
string | Ios third party request body, mandatory when iosType is thirdParty.You can pass both plaintext and base64 encode text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
iosPushThirdPartyRequestHeaders |
iosPushThirdPartyRequestHeaders[] | Reference to IOS Push Third Party Request Header. |
IOS Push Third Party Request Header JSON Format:
| Name | Type | Description |
|---|---|---|
id |
guid | Id of the IOS push third party request header. |
field |
string | Field of the IOS push third party request header. |
content |
string | Content of the IOS push third party request header. |
Endpoint
Get a single IOS Push
GET livechat/iosPush
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
include |
string | query | no | Allowed value is "iosPushThirdPartyRequestHeader". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/iosPush \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the IOS Push
PUT livechat/iosPush
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
iosType |
string | body | no | Allowed values are "apns", "thirdParty". |
iosProductionCertificateFileName |
string | body | no | Name of ios production certificate file. |
iosProductionCertificateFileData |
file | body | no | Data of ios production certificate file. |
iosProductionCertificatePassword |
string | body | no | Password of ios production certificate file. |
iosDevelopmentCertificateFileName |
string | body | no | Name of ios development certificate file. |
iosDevelopmentCertificateFileData |
file | body | no | Data of ios development certificate file. |
iosDevelopmentCertificatePassword |
string | body | no | Password of ios development certificate file. |
iosAPNSPayloadFormat |
string | body | yes | Format of ios APNS payload, mandatory when iosType is thirdParty.You can pass both plaintext and base64 encode text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
iosThirdPartyURL |
string | body | yes | Ios third party URL, mandatory when iosType is thirdParty. |
iosThirdPartyRequestBody |
string | body | yes | Ios third party request body, mandatory when iosType is thirdParty.You can pass both plaintext and base64 encode text. If the request containing plaintext is blocked by comm100 WAF, use base64 format. When using base64, add "data:text/plain;base64," before the content. |
iosPushThirdPartyRequestHeaders |
iosPushThirdPartyRequestHeaders[] | body | no | Reference to IOS Push Third Party Request Header. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/iosPush \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"iosType":"apns","iosProductionCertificateFileName":"DEV.p12","iosProductionCertificateFileData":"","iosProductionCertificatePassword":"111111","iosDevelopmentCertificateFileName":"DEV.p12","iosDevelopmentCertificateFileData":"","iosDevelopmentCertificatePassword":"111111","iosAPNSPayloadFormat":"{\\n\\t\\\"name\\\":\\\"fcc\\\",\\n\\t\\\"index\\\":\\\"index.html\\\",\\n\\t\\\"icon\\\":\\\"/fdsfsd.png\\\",\\n\\t\\\"author\\\":{\\n\\t\\\"name\\\":\\\"fcc\\\",\\n\\t\\\"eamil\\\":\\\"fccdsf@163.com\\\",\\n\\t\\\"url\\\":\\\"www.baidu.com\\\"\\n\\t},\\n\\t\\\"version\\\":\\\"1.0\\\",\\n\\t\\\"manifestVersion\\\":\\\"1.0\\\"\\n}","iosThirdPartyURL":"www.comm100.com","iosThirdPartyRequestBody":"1","iosPushThirdPartyRequestHeaders":[{"field":"Temporary field","content":"Content"}]}'
Response:
HTTP/1.1 200 OK