- Category: phone & sms
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 14
- Triggers: 0
- Slug:
HLR_LOOKUP - Version: 20261101_00
Tools
Check Phone Status
Check Phone Status
Slug:
HLR_LOOKUP_CHECK_PHONE_STATUSRun full HLR lookups for 1-80 phone numbers. This processes sensitive phone data and spends credits; optional status features can increase the cost.Input Parameters
One to 80 phone-number lookup requests. Each item defaults to private caching and disables optional billable features.
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.
Output
Create Batch
Create Batch
Slug:
HLR_LOOKUP_CREATE_BATCHCreate an empty persistent HLR_V2 batch. Creation has no documented charge and handles no phone data; later uploads persist sensitive phone data, and processing can spend credits.Input Parameters
Processing options for the future HLR batch. Private caching and non-billable feature defaults are applied when omitted.
Output
Delete Batch
Delete Batch
Slug:
HLR_LOOKUP_DELETE_BATCHPermanently delete one HLR batch and its results. This action is irreversible: never invoke it without explicit authorization, and download all needed results before deletion. It does not select a batch automatically.Input Parameters
ID of the batch to permanently delete. Confirm explicit authorization, the intended account, and that all needed results were downloaded first.
Output
Download Batch Results
Download Batch Results
Slug:
HLR_LOOKUP_DOWNLOAD_BATCH_RESULTSDownload a completed batch’s CSV or JSON result export as a file reference, selecting the format explicitly. The export may contain sensitive phone data and HLR intelligence; JSON results are sanitized before delivery.Input Parameters
Required result export format. CSV and JSON use different provider routes.
Output
Get Credit Balance
Get Credit Balance
Get Batch
Get Batch
List Batches
List Batches
Run MNP Lookup
Run MNP Lookup
Slug:
HLR_LOOKUP_MNP_LOOKUPLook up network and mobile-number-portability data for 1-80 phone numbers. This processes sensitive phone data and spends credits; requesting the optional ported date is the only MNP feature that can add a surcharge.Input Parameters
One to 80 portability lookup requests. Each item defaults to private caching and disables the optional billable ported-date feature.
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.
Output
Pause Batch
Pause Batch
Schedule Batch
Schedule Batch
Start or Resume Batch
Start or Resume Batch
Upload Batch CSV
Upload Batch CSV
Slug:
HLR_LOOKUP_UPLOAD_BATCH_CSVUpload a CSV file of sensitive phone data into an empty HLR batch. The provider permits one source upload; repeating it on a populated batch is documented to fail.Input Parameters
Zero-based CSV column containing phone numbers. Defaults to the first column; the provider does not document a maximum.
CSV file whose raw bytes contain the phone-number source data. No official row or file-size limit is documented.
Output
Upload Batch Phone Numbers
Upload Batch Phone Numbers
Slug:
HLR_LOOKUP_UPLOAD_BATCH_JSONUpload 1-100,000 sensitive phone numbers into an empty HLR batch as a compact JSON array. The UTF-8 body must not exceed 2 MiB, and a populated batch cannot be uploaded again.Input Parameters
Phone numbers to upload. The provider accepts 1-100,000 values, and their compact UTF-8 JSON array must not exceed 2 MiB.
Output
Validate Phone Numbers
Validate Phone Numbers
Slug:
HLR_LOOKUP_VALIDATE_NUMBERValidate formatting and original-network information for 1-80 phone numbers without a live HLR lookup. It costs zero credits but still processes sensitive phone data.Input Parameters
Optional caller account reference sent only in the provider’s AccountID header. This is not an authentication credential.
Optional caller reference sent only in the provider’s ReferenceID header for request reconciliation.