NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Callerapi connects to a Nagent workspace with an API key. Once it is connected, agents can call 7 Callerapi actions, such as "Get Phone Number Information", "Get User Information" and "List Webhook Subscriptions". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Callerapi, with input parameters and output schema.
CALLERAPI_DISPATCH_REPORTS_MANUALLYTool to manually trigger today's spam reports webhook delivery for enterprise clients. Use when an immediate webhook dispatch of spam complaint reports is needed. This endpoint is restricted to enterprise accounts only.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_GET_PHONE_NUMBER_INFORMATIONTool to retrieve detailed information about a specific phone number, including reputation, business and carrier details, and FTC complaints. Use when the number is in E.164 format and set hlr=true to include HLR data (adds 1-3 seconds to response).
Input parameters
Include HLR (Home Location Register) data; adds 1-3 seconds to response but incurs no extra cost.
The phone number in E.164 format, e.g., '+16502530000'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_GET_USER_INFORMATIONTool to retrieve information about the authenticated user, including email and credit usage details. Use after authentication to fetch current credits spent, monthly allocation, and credits left.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_LIST_WEBHOOK_SUBSCRIPTIONSTool to list all webhook subscriptions for daily spam reports. Enterprise clients only. Use to retrieve all configured webhook endpoints that receive spam complaint notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_SUBSCRIBE_DAILY_REPORTSTool to subscribe to daily spam report webhooks for enterprise clients. Instead of polling, receive webhook deliveries with spam complaint data daily. Use when you want to set up automated daily reports for spam complaints.
Input parameters
Webhook URL where daily spam report data will be delivered. Must be a valid HTTPS URL accessible from CallerAPI servers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_TEST_WEBHOOKTool to send a sample webhook payload to test your webhook endpoint integration. Use to validate webhook signature verification and endpoint configuration. Enterprise clients only.
Input parameters
Webhook URL to send test payload to for validation. Must be a valid HTTPS URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLERAPI_UNSUBSCRIBE_DAILY_REPORTSTool to unsubscribe from daily spam report webhooks. Use when you need to stop receiving daily reports at a specific webhook URL. Enterprise clients only.
Input parameters
Webhook URL to unsubscribe from daily spam reports. Must be a valid URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 7 Callerapi actions on Nagent, including "Get Phone Number Information", "Get User Information" and "List Webhook Subscriptions". Get Phone Number Information: Retrieve detailed information about a specific phone number, including reputation, business and carrier details, and FTC complaints. Each action is listed on this page with its input parameters and its output.
Callerapi connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Phone Number Information takes 1 required input: phone. It also takes 1 optional input: hlr. It returns data, error and successful.