For the complete documentation index, see llms.txt. This page is also available as Markdown.

API.EWS.03 SYN FetchPhoneNumbers

The Phone Number Retrieval API facilitates the secure retrieval of beneficiary phone numbers from the Social Protection (SP) system to support targeted communication during emergencies or awareness campaigns initiated by the Early Warning System (EWS). Through this interface, the EWS can request phone numbers associated with beneficiaries that meet specific criteria such as geographic location, program participation, or vulnerability category. The API follows the principle of data minimization, returning only the phone numbers required for communication and not exposing full personal or household records.

API definition link:

/fetch-phone-numbers The EWS system can request phone numbers from the SP system using defined search parameters such as geographic area, program participation, or other targeting criteria. The SP system returns only the phone numbers necessary for communication purposes.

Please refer to GitHub for YAML object definitions: YAML definitions

Note: The above YAML is consolidated. For any changes, kindly raise a pull request on GitHub.

Last updated

Was this helpful?