# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## manage_dialer_numbers Inspect the workspace's dialing numbers, search the carrier for purchasable ones, assign a number to a rep, change its health or forwarding, and give one back. Use to keep the number fleet correct: park a flagged number, move a DID to the rep who needs it, or retire one nobody uses. Releasing is permanent — the carrier may reissue the number to someone else, and any campaign or forwarding that depended on it stops. Reassigning a number away from a rep mid-session removes it from their next dial. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:read, dialer:manage_numbers, dialer:manage_number_health, dialer:assign_numbers, dialer:release_numbers Risk: destructive; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "list", "get", "search_available", "provisioning_options", "assign", "update", "release" ] }, "numberId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "assignedUserId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dialableOnly": { "type": "string", "enum": [ "true", "false" ] } }, "patternProperties": { "^(?!(?:offset|limit|assignedUserId|status|dialableOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "assignedUserId", "status", "dialableOnly" ] } }, "search": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "search": { "type": "string", "maxLength": 32 }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "limit": { "type": "integer", "minimum": 1, "maximum": 20 } }, "patternProperties": { "^(?!(?:countryCode|search|areaCode|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "search", "areaCode", "limit" ] } }, "assign": { "type": "object", "properties": { "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "confirmedSessionId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "assignedUserId" ], "patternProperties": { "^(?!(?:assignedUserId|confirmedSessionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "assignedUserId", "confirmedSessionId" ] } }, "update": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:status|dailyCallCap|inboundEnabled|inboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "dailyCallCap", "inboundEnabled", "inboundForwardE164" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|list|search|assign|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "list", "search", "assign", "update" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "list", "get", "search_available", "provisioning_options", "assign", "update", "release" ] }, "numberId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "assignedUserId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dialableOnly": { "type": "string", "enum": [ "true", "false" ] } }, "patternProperties": { "^(?!(?:offset|limit|assignedUserId|status|dialableOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "assignedUserId", "status", "dialableOnly" ] } }, "search": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "search": { "type": "string", "maxLength": 32 }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "limit": { "type": "integer", "minimum": 1, "maximum": 20 } }, "patternProperties": { "^(?!(?:countryCode|search|areaCode|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "search", "areaCode", "limit" ] } }, "assign": { "type": "object", "properties": { "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "confirmedSessionId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "assignedUserId" ], "patternProperties": { "^(?!(?:assignedUserId|confirmedSessionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "assignedUserId", "confirmedSessionId" ] } }, "update": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:status|dailyCallCap|inboundEnabled|inboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "dailyCallCap", "inboundEnabled", "inboundForwardE164" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|list|search|assign|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "list", "search", "assign", "update" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "administrativeArea": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "features": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "addressRequirement": { "type": "string", "enum": [ "none", "any", "local", "foreign" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] } }, "required": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ], "patternProperties": { "^(?!(?:phoneNumber|countryCode|locality|administrativeArea|features|addressRequirement|voiceProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "countryName": { "$ref": "#/$defs/ShortText" }, "numberType": { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, "numberTypeName": { "$ref": "#/$defs/ShortText" }, "messaging": { "type": "string", "enum": [ "sms_mms", "sms", "voice_only" ] }, "searchKind": { "type": "string", "enum": [ "nanp", "international" ] }, "requiresRegulatoryBundle": { "type": "boolean" } }, "required": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ], "patternProperties": { "^(?!(?:countryCode|countryName|numberType|numberTypeName|messaging|searchKind|requiresRegulatoryBundle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "numberId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "releasedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "numberId", "phoneE164", "releasedAt" ], "patternProperties": { "^(?!(?:numberId|phoneE164|releasedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "phoneE164", "releasedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "administrativeArea": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "features": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "addressRequirement": { "type": "string", "enum": [ "none", "any", "local", "foreign" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] } }, "required": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ], "patternProperties": { "^(?!(?:phoneNumber|countryCode|locality|administrativeArea|features|addressRequirement|voiceProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "countryName": { "$ref": "#/$defs/ShortText" }, "numberType": { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, "numberTypeName": { "$ref": "#/$defs/ShortText" }, "messaging": { "type": "string", "enum": [ "sms_mms", "sms", "voice_only" ] }, "searchKind": { "type": "string", "enum": [ "nanp", "international" ] }, "requiresRegulatoryBundle": { "type": "boolean" } }, "required": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ], "patternProperties": { "^(?!(?:countryCode|countryName|numberType|numberTypeName|messaging|searchKind|requiresRegulatoryBundle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "numberId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "releasedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "numberId", "phoneE164", "releasedAt" ], "patternProperties": { "^(?!(?:numberId|phoneE164|releasedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "phoneE164", "releasedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerNumbers.list`: `GET /v1/workspaces/:workspaceId/dialer/numbers` - `dialerNumbers.get`: `GET /v1/workspaces/:workspaceId/dialer/numbers/:numberId` - `dialerNumbers.searchAvailable`: `GET /v1/workspaces/:workspaceId/dialer/numbers/search-available` - `dialerNumbers.provisioningOptions`: `GET /v1/workspaces/:workspaceId/dialer/numbers/provisioning-options` - `dialerNumbers.assign`: `PATCH /v1/workspaces/:workspaceId/dialer/numbers/:numberId/assign` - `dialerNumbers.update`: `PATCH /v1/workspaces/:workspaceId/dialer/numbers/:numberId` - `dialerNumbers.release`: `DELETE /v1/workspaces/:workspaceId/dialer/numbers/:numberId`