phone

Format a phone number in a chosen style

Formats a phone number in one of five styles: 'numeric' (digits only), 'dashed' (555-123-4567), 'parentheses' ((555) 123-4567), 'e164' (+15551234567), or 'international' (+1 555-123-4567). The first three styles honor add_country_code=true to prepend the detected country code. e164 and international always include it by definition. Parses using country_hint for ambiguous non-E.164 input.

post/v1/phone/format

Request

  • Base URL: https://api.snipget.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.snipget.ai/v1/phone/format
  • Auth: none declared

Query parameters

include_receiptboolean

Set true to attach an execution receipt at meta.receipt — caller-verifiable sha256 hashes over the RFC 8785 (JCS) canonicalization of this call's as-received JSON body and its result (free, like include_trace). Reproduce with any JCS library: input_hash = sha256(jcs({"tool": <request path>, "args": <your body minus include_trace/include_receipt>})); result_hash = sha256(jcs(result)). For deterministic tools, same input on the same build reproduces result_hash.

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

valuestring required

Phone number to format.

stylestring

Output style: 'numeric' (digits only), 'dashed' (555-123-4567), 'parentheses' ((555) 123-4567), 'e164' (+15551234567), or 'international' (+1 555-123-4567).

country_hintstring nullable
add_country_codeboolean

When true, prepend the country code to the formatted number for the numeric/dashed/parentheses styles. The e164 and international styles always include the country code.

include_traceboolean

Response

Successful Response

statusstring
confidencenumber required

Changes

No recorded changes to this operation across all 1 revision of this API.