Signals (Beta)
Create Signal
Create a Signal object.
This endpoint requires the following mandatory parameters:
consent, phone, countryCode, and templateId.
Supported Template
| Template ID | Region | Required Parameters |
|---|---|---|
| tpl-sgn003001 | PH (default) | consent, templateId, countryCode, phone |
| signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8 (deprecated) | PH (default) | consent, templateId, countryCode, phone |
| signalTpl-f250f305c3bf0aa690cca93ef0f0fb03 (deprecated) | PH (default) | consent, templateId, countryCode, phone |
| signalTpl-f6b74d81a4807f4c01e6a920920775ad (deprecated) | PH (default) | consent, templateId, countryCode, phone |
| signalTpl-7a01659636c119ca4566308effd05d06 (deprecated) | PH (default) | consent, templateId, countryCode, phone |
| signalTpl-e5ba74fe8089fe44eeeafb68991b1e70 (deprecated) | PH (default) | consent, templateId, countryCode, phone |
Field Guidelines
- phone must include the country code (e.g., +639559991234 or 639559991234)
- MD5 encryption is supported using the format: MD5(countryCode + phone),
e.g., MD5(+639559991234)
Sandbox Test Values
| Parameter | Value | Expected Response |
|---|---|---|
| templateId | tpl-sgn003001 | |
| countryCode | PH | |
| phone | 639559991234 | resultCode = SUCCESS |
For all other valid phone and countryCode combinations, the response will return:
resultCode = NO_DATA, and no items will be included.
You may also contact Smile to request additional specialized templateIds for other regions or business cases.
post/beta/signals
Request body
Example request
{
"phone": "+639559991234",
"templateId": "signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8",
"consent": {
"type": "Terms and Conditions",
"version": "1.0.0",
"consentedAt": "2021-04-14T09:30:24Z",
"consentedWith": "I agree to the terms and conditions"
},
"countryCode": "PH"
}Response
OK
Example response
{
"code": "OK",
"message": "Success",
"requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
"data": {
"createdAt": "2021-04-14T09:30:24Z",
"requestMeta": {
"fullName": "John Doe",
"phone": "529559991234",
"curp": "DOEJ800101HDFXXX01",
"templateId": "tpl-sgn003002",
"consent": {
"type": "Terms and Conditions",
"version": "1.0.0",
"consentedAt": "2021-04-14T09:30:24Z",
"consentedWith": "I agree to the terms and conditions"
}
}
}
}