# Phone Numbers ## List phone numbers `phone_numbers.list() -> PhoneNumberListResponse` **get** `/v3/phone_numbers` Returns all phone numbers assigned to the authenticated partner. Use this endpoint to discover which phone numbers are available for use as the `from` field when creating a chat, listing chats, or sending a voice memo. ### Returns - `class PhoneNumberListResponse: …` - `phone_numbers: List[PhoneNumber]` List of phone numbers assigned to the partner - `id: str` Unique identifier for the phone number - `phone_number: str` Phone number in E.164 format - `reputation: PhoneNumberReputation` **[BETA]** Current reputation for a phone line. Always present — lines start at `HEALTHY` and may shift based on aggregate engagement and delivery signals across all conversations on the line. Unlike chat health, line reputation does not include `opted_out` — opt-out applies to individual recipients, not the whole line. See the [Phone Reputation guide](/channel/imessage/guides/phone-numbers/phone-reputation) for what each status means and how to react. - `doc_url: str` Deep-link to the relevant section of the Phone Reputation guide for this status. - `status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]` Current reputation of this phone line. - `HEALTHY` — The line is in good standing. Send normally. - `AT_RISK` — Warning signs on the line: engagement is low across many of its conversations, or it's starting too many brand-new conversations in a single day — and a spike in send volume can add to either. Slow the line's send pace, avoid opening many new conversations at once, and review your messaging patterns. - `CRITICAL` — Strong signals that messages from this line aren't landing well. Pause outbound on the line until it recovers. Defaults to `HEALTHY` for lines that have not yet been scored. - `"HEALTHY"` - `"AT_RISK"` - `"CRITICAL"` - `forwarding_number: Optional[str]` The forwarding number associated with this phone number, in E.164 format. Null when no forwarding number is configured. ### Example ```python import os from linq import LinqAPIV3 client = LinqAPIV3( api_key=os.environ.get("LINQ_API_V3_API_KEY"), # This is the default and can be omitted ) phone_numbers = client.phone_numbers.list() print(phone_numbers.phone_numbers) ``` #### Response ```json { "phone_numbers": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "phone_number": "+12025551234", "forwarding_number": "+12025559999", "reputation": { "status": "HEALTHY", "doc_url": "https://docs.linqapp.com/channel/imessage/guides/phone-numbers/phone-reputation#healthy" } }, { "id": "550e8400-e29b-41d4-a716-446655440001", "phone_number": "+12025559876", "forwarding_number": null, "reputation": { "status": "AT_RISK", "doc_url": "https://docs.linqapp.com/channel/imessage/guides/phone-numbers/phone-reputation#at-risk" } } ] } ``` ## Update a phone number `phone_numbers.update(strphone_number_id, PhoneNumberUpdateParams**kwargs) -> PhoneNumberUpdateResponse` **put** `/v3/phone_numbers/{phoneNumberId}` Updates the forwarding number for a phone number. The forwarding number is where inbound calls will be forwarded to. Pass an empty string to clear the forwarding number. ### Parameters - `phone_number_id: str` - `forwarding_number: Optional[str]` The forwarding number in E.164 format. Set to null or empty string to clear. ### Returns - `class PhoneNumberUpdateResponse: …` - `id: str` Unique identifier for the phone number - `forwarding_number: Optional[str]` The forwarding number after the update. Null when cleared. - `phone_number: str` Phone number in E.164 format ### Example ```python import os from linq import LinqAPIV3 client = LinqAPIV3( api_key=os.environ.get("LINQ_API_V3_API_KEY"), # This is the default and can be omitted ) phone_number = client.phone_numbers.update( phone_number_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", forwarding_number="+12025559999", ) print(phone_number.id) ``` #### Response ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "phone_number": "+12025551234", "forwarding_number": "+12025559999" } ``` ## Start a line reputation audit `phone_numbers.start_reputation_audit(strphone_number) -> ReputationAuditStarted` **post** `/v3/phone_numbers/{phoneNumber}/reputation_audit` Starts an asynchronous reputation audit for a line and returns an `audit_id`. Poll the GET endpoint for the result. Rate limited per line: only one audit may run at a time. Starting one while another is still running returns `202` with the running audit's `audit_id` rather than an error, so a retried start picks that audit back up instead of losing it — poll the id you were given. Once an audit finishes, a new one can't be started for the same line until a cooldown elapses (`429`, with `Retry-After` carrying the wait). Keep the `audit_id` from the original `202`: it stays readable on the GET endpoint for 24 hours, and the cooldown response does not repeat it. ### Parameters - `phone_number: str` ### Returns - `class ReputationAuditStarted: …` - `audit_id: str` Identifier for this audit. Poll `GET /v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}` until `status` is `complete` or `error`. - `status: Literal["pending", "complete", "error"]` A newly started audit is `pending`. - `"pending"` - `"complete"` - `"error"` ### Example ```python import os from linq import LinqAPIV3 client = LinqAPIV3( api_key=os.environ.get("LINQ_API_V3_API_KEY"), # This is the default and can be omitted ) reputation_audit_started = client.phone_numbers.start_reputation_audit( "phoneNumber", ) print(reputation_audit_started.audit_id) ``` #### Response ```json { "audit_id": "audit_id", "status": "pending" } ``` ## Get a line reputation audit `phone_numbers.get_reputation_audit(straudit_id, PhoneNumberGetReputationAuditParams**kwargs) -> ReputationAudit` **get** `/v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}` Returns the audit's status and, once complete, the report. Audits are scoped to the line in the URL — an `auditId` started on a different line returns `404`. ### Parameters - `phone_number: str` - `audit_id: str` ### Returns - `class ReputationAudit: …` - `audit_id: str` - `status: Literal["pending", "complete", "error"]` `pending` until the report is ready — poll until `complete` or `error`. - `"pending"` - `"complete"` - `"error"` - `error: Optional[str]` Present only when `status` is `error`. Short, generic reason safe to display. - `generated_at: Optional[datetime]` When the report was generated; signals reflect the line at this moment. - `phone: Optional[str]` The line audited, E.164. - `report: Optional[ReputationReport]` Present only when `status` is `complete`. - `action_items: Optional[List[ReputationActionItem]]` Ordered by `priority`; 1 = do first. - `detail: Optional[str]` - `expected_impact: Optional[Literal["high", "medium", "low"]]` - `"high"` - `"medium"` - `"low"` - `priority: Optional[int]` 1 = do first - `title: Optional[str]` - `drivers: Optional[List[ReputationDriver]]` Ranked, highest impact first. - `key: Optional[ReputationDriverKey]` Stable driver-category identifier — what is dragging the line, or one of its conversations, down. - `low_engagement` — The conversation is one-sided: several messages sent, few or no replies back. Pause or rework outreach where recipients are not replying, and lead with messages that invite a response. Conversation-level: it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`. - `overall_conversation_health` — A large share of the line's active conversations are trending unhealthy. Fix the unhealthy conversations first — review their content and timing, and whether recipients are engaging. - `volume_spike` — The line's daily sending volume jumped far above its own normal level while few recipients were replying, or exceeded the recommended daily volume for a single line. Ramp volume gradually instead of spiking, prioritize people who have already engaged with you, and spread sustained high volume across additional lines. - `new_conversation_rate` — The line is starting too many brand-new conversations in a single day. Spread new conversations out over time instead of starting many at once. - `opt_out_handling` — Recipients asked this line to stop. Honor every stop request immediately: send nothing further to that recipient unless they opt back in. Every send to them is rejected with `403` (error code `2024`), including a final courtesy message — to send one telling them they can reply to resume, set `override_optout: true` on that single request. - `flagged` — The line is currently restricted and its messages may not be reaching recipients. Move active traffic to a healthy line now, and let this one recover before sending more. - `other` — Fallback for a signal without dedicated partner copy. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `metric: Optional[str]` A specific observed figure when available; otherwise a short qualitative note. - `summary: Optional[str]` One plain-English sentence. - `evidence: Optional[ReputationEvidence]` The specific conversations behind the drivers, so partners can verify every claim against their own send logs. Each `chat_id` can be fetched via `GET /v3/chats/{chatId}` — its current health appears there. - `opt_out_chats: Optional[List[ReputationOptOutChat]]` Worst first — most messages sent after the stop request; honor these immediately. - `chat_id: Optional[str]` - `messages_after_stop: Optional[int]` Outbound messages sent after the recipient asked to stop. - `unhealthy_chats: Optional[List[ReputationUnhealthyChat]]` Up to 15, worst first. - `chat_id: Optional[str]` - `driver_keys: Optional[List[ReputationDriverKey]]` What is dragging this conversation down, in the same vocabulary as the report's drivers. Each key's meaning and the fix for it are documented on `ReputationDriverKey`. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `status: Optional[Literal["AT_RISK", "CRITICAL", "OPTED_OUT"]]` The conversation's current health — the same value `GET /v3/chats/{chatId}` reports for it. - `"AT_RISK"` - `"CRITICAL"` - `"OPTED_OUT"` - `primary_driver: Optional[str]` The `key` of the most important driver. Empty string when the line has nothing to act on — the report then carries a single reassurance action item. Its values are the `ReputationDriverKey` vocabulary — see that schema for what each means and what to do about it. - `severity: Optional[Literal["HEALTHY", "AT_RISK", "CRITICAL"]]` Current reputation of this phone line. - `HEALTHY` — The line is in good standing. Send normally. - `AT_RISK` — Warning signs on the line: engagement is low across many of its conversations, or it's starting too many brand-new conversations in a single day — and a spike in send volume can add to either. Slow the line's send pace, avoid opening many new conversations at once, and review your messaging patterns. - `CRITICAL` — Strong signals that messages from this line aren't landing well. Pause outbound on the line until it recovers. Defaults to `HEALTHY` for lines that have not yet been scored. - `"HEALTHY"` - `"AT_RISK"` - `"CRITICAL"` - `summary_markdown: Optional[str]` Deterministic markdown rendering of this report, suitable for feeding directly to automated systems and AI agents as investigation context. Rendered from the structured fields above, which remain the source of truth. ### Example ```python import os from linq import LinqAPIV3 client = LinqAPIV3( api_key=os.environ.get("LINQ_API_V3_API_KEY"), # This is the default and can be omitted ) reputation_audit = client.phone_numbers.get_reputation_audit( audit_id="auditId", phone_number="phoneNumber", ) print(reputation_audit.audit_id) ``` #### Response ```json { "audit_id": "audit_id", "status": "pending", "error": "error", "generated_at": "2019-12-27T18:11:19.117Z", "phone": "phone", "report": { "action_items": [ { "detail": "detail", "expected_impact": "high", "priority": 0, "title": "title" } ], "drivers": [ { "key": "low_engagement", "metric": "metric", "summary": "summary" } ], "evidence": { "opt_out_chats": [ { "chat_id": "chat_id", "messages_after_stop": 0 } ], "unhealthy_chats": [ { "chat_id": "chat_id", "driver_keys": [ "low_engagement" ], "status": "AT_RISK" } ] }, "primary_driver": "primary_driver", "severity": "HEALTHY", "summary_markdown": "## Line reputation summary\n\n**Status:** AT_RISK\n..." } } ``` ## Domain Types ### Reputation Action Item - `class ReputationActionItem: …` - `detail: Optional[str]` - `expected_impact: Optional[Literal["high", "medium", "low"]]` - `"high"` - `"medium"` - `"low"` - `priority: Optional[int]` 1 = do first - `title: Optional[str]` ### Reputation Audit - `class ReputationAudit: …` - `audit_id: str` - `status: Literal["pending", "complete", "error"]` `pending` until the report is ready — poll until `complete` or `error`. - `"pending"` - `"complete"` - `"error"` - `error: Optional[str]` Present only when `status` is `error`. Short, generic reason safe to display. - `generated_at: Optional[datetime]` When the report was generated; signals reflect the line at this moment. - `phone: Optional[str]` The line audited, E.164. - `report: Optional[ReputationReport]` Present only when `status` is `complete`. - `action_items: Optional[List[ReputationActionItem]]` Ordered by `priority`; 1 = do first. - `detail: Optional[str]` - `expected_impact: Optional[Literal["high", "medium", "low"]]` - `"high"` - `"medium"` - `"low"` - `priority: Optional[int]` 1 = do first - `title: Optional[str]` - `drivers: Optional[List[ReputationDriver]]` Ranked, highest impact first. - `key: Optional[ReputationDriverKey]` Stable driver-category identifier — what is dragging the line, or one of its conversations, down. - `low_engagement` — The conversation is one-sided: several messages sent, few or no replies back. Pause or rework outreach where recipients are not replying, and lead with messages that invite a response. Conversation-level: it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`. - `overall_conversation_health` — A large share of the line's active conversations are trending unhealthy. Fix the unhealthy conversations first — review their content and timing, and whether recipients are engaging. - `volume_spike` — The line's daily sending volume jumped far above its own normal level while few recipients were replying, or exceeded the recommended daily volume for a single line. Ramp volume gradually instead of spiking, prioritize people who have already engaged with you, and spread sustained high volume across additional lines. - `new_conversation_rate` — The line is starting too many brand-new conversations in a single day. Spread new conversations out over time instead of starting many at once. - `opt_out_handling` — Recipients asked this line to stop. Honor every stop request immediately: send nothing further to that recipient unless they opt back in. Every send to them is rejected with `403` (error code `2024`), including a final courtesy message — to send one telling them they can reply to resume, set `override_optout: true` on that single request. - `flagged` — The line is currently restricted and its messages may not be reaching recipients. Move active traffic to a healthy line now, and let this one recover before sending more. - `other` — Fallback for a signal without dedicated partner copy. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `metric: Optional[str]` A specific observed figure when available; otherwise a short qualitative note. - `summary: Optional[str]` One plain-English sentence. - `evidence: Optional[ReputationEvidence]` The specific conversations behind the drivers, so partners can verify every claim against their own send logs. Each `chat_id` can be fetched via `GET /v3/chats/{chatId}` — its current health appears there. - `opt_out_chats: Optional[List[ReputationOptOutChat]]` Worst first — most messages sent after the stop request; honor these immediately. - `chat_id: Optional[str]` - `messages_after_stop: Optional[int]` Outbound messages sent after the recipient asked to stop. - `unhealthy_chats: Optional[List[ReputationUnhealthyChat]]` Up to 15, worst first. - `chat_id: Optional[str]` - `driver_keys: Optional[List[ReputationDriverKey]]` What is dragging this conversation down, in the same vocabulary as the report's drivers. Each key's meaning and the fix for it are documented on `ReputationDriverKey`. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `status: Optional[Literal["AT_RISK", "CRITICAL", "OPTED_OUT"]]` The conversation's current health — the same value `GET /v3/chats/{chatId}` reports for it. - `"AT_RISK"` - `"CRITICAL"` - `"OPTED_OUT"` - `primary_driver: Optional[str]` The `key` of the most important driver. Empty string when the line has nothing to act on — the report then carries a single reassurance action item. Its values are the `ReputationDriverKey` vocabulary — see that schema for what each means and what to do about it. - `severity: Optional[Literal["HEALTHY", "AT_RISK", "CRITICAL"]]` Current reputation of this phone line. - `HEALTHY` — The line is in good standing. Send normally. - `AT_RISK` — Warning signs on the line: engagement is low across many of its conversations, or it's starting too many brand-new conversations in a single day — and a spike in send volume can add to either. Slow the line's send pace, avoid opening many new conversations at once, and review your messaging patterns. - `CRITICAL` — Strong signals that messages from this line aren't landing well. Pause outbound on the line until it recovers. Defaults to `HEALTHY` for lines that have not yet been scored. - `"HEALTHY"` - `"AT_RISK"` - `"CRITICAL"` - `summary_markdown: Optional[str]` Deterministic markdown rendering of this report, suitable for feeding directly to automated systems and AI agents as investigation context. Rendered from the structured fields above, which remain the source of truth. ### Reputation Audit Started - `class ReputationAuditStarted: …` - `audit_id: str` Identifier for this audit. Poll `GET /v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}` until `status` is `complete` or `error`. - `status: Literal["pending", "complete", "error"]` A newly started audit is `pending`. - `"pending"` - `"complete"` - `"error"` ### Reputation Driver - `class ReputationDriver: …` - `key: Optional[ReputationDriverKey]` Stable driver-category identifier — what is dragging the line, or one of its conversations, down. - `low_engagement` — The conversation is one-sided: several messages sent, few or no replies back. Pause or rework outreach where recipients are not replying, and lead with messages that invite a response. Conversation-level: it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`. - `overall_conversation_health` — A large share of the line's active conversations are trending unhealthy. Fix the unhealthy conversations first — review their content and timing, and whether recipients are engaging. - `volume_spike` — The line's daily sending volume jumped far above its own normal level while few recipients were replying, or exceeded the recommended daily volume for a single line. Ramp volume gradually instead of spiking, prioritize people who have already engaged with you, and spread sustained high volume across additional lines. - `new_conversation_rate` — The line is starting too many brand-new conversations in a single day. Spread new conversations out over time instead of starting many at once. - `opt_out_handling` — Recipients asked this line to stop. Honor every stop request immediately: send nothing further to that recipient unless they opt back in. Every send to them is rejected with `403` (error code `2024`), including a final courtesy message — to send one telling them they can reply to resume, set `override_optout: true` on that single request. - `flagged` — The line is currently restricted and its messages may not be reaching recipients. Move active traffic to a healthy line now, and let this one recover before sending more. - `other` — Fallback for a signal without dedicated partner copy. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `metric: Optional[str]` A specific observed figure when available; otherwise a short qualitative note. - `summary: Optional[str]` One plain-English sentence. ### Reputation Driver Key - `Literal["low_engagement", "overall_conversation_health", "volume_spike", 4 more]` Stable driver-category identifier — what is dragging the line, or one of its conversations, down. - `low_engagement` — The conversation is one-sided: several messages sent, few or no replies back. Pause or rework outreach where recipients are not replying, and lead with messages that invite a response. Conversation-level: it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`. - `overall_conversation_health` — A large share of the line's active conversations are trending unhealthy. Fix the unhealthy conversations first — review their content and timing, and whether recipients are engaging. - `volume_spike` — The line's daily sending volume jumped far above its own normal level while few recipients were replying, or exceeded the recommended daily volume for a single line. Ramp volume gradually instead of spiking, prioritize people who have already engaged with you, and spread sustained high volume across additional lines. - `new_conversation_rate` — The line is starting too many brand-new conversations in a single day. Spread new conversations out over time instead of starting many at once. - `opt_out_handling` — Recipients asked this line to stop. Honor every stop request immediately: send nothing further to that recipient unless they opt back in. Every send to them is rejected with `403` (error code `2024`), including a final courtesy message — to send one telling them they can reply to resume, set `override_optout: true` on that single request. - `flagged` — The line is currently restricted and its messages may not be reaching recipients. Move active traffic to a healthy line now, and let this one recover before sending more. - `other` — Fallback for a signal without dedicated partner copy. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` ### Reputation Evidence - `class ReputationEvidence: …` The specific conversations behind the drivers, so partners can verify every claim against their own send logs. Each `chat_id` can be fetched via `GET /v3/chats/{chatId}` — its current health appears there. - `opt_out_chats: Optional[List[ReputationOptOutChat]]` Worst first — most messages sent after the stop request; honor these immediately. - `chat_id: Optional[str]` - `messages_after_stop: Optional[int]` Outbound messages sent after the recipient asked to stop. - `unhealthy_chats: Optional[List[ReputationUnhealthyChat]]` Up to 15, worst first. - `chat_id: Optional[str]` - `driver_keys: Optional[List[ReputationDriverKey]]` What is dragging this conversation down, in the same vocabulary as the report's drivers. Each key's meaning and the fix for it are documented on `ReputationDriverKey`. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `status: Optional[Literal["AT_RISK", "CRITICAL", "OPTED_OUT"]]` The conversation's current health — the same value `GET /v3/chats/{chatId}` reports for it. - `"AT_RISK"` - `"CRITICAL"` - `"OPTED_OUT"` ### Reputation Opt Out Chat - `class ReputationOptOutChat: …` - `chat_id: Optional[str]` - `messages_after_stop: Optional[int]` Outbound messages sent after the recipient asked to stop. ### Reputation Report - `class ReputationReport: …` - `action_items: Optional[List[ReputationActionItem]]` Ordered by `priority`; 1 = do first. - `detail: Optional[str]` - `expected_impact: Optional[Literal["high", "medium", "low"]]` - `"high"` - `"medium"` - `"low"` - `priority: Optional[int]` 1 = do first - `title: Optional[str]` - `drivers: Optional[List[ReputationDriver]]` Ranked, highest impact first. - `key: Optional[ReputationDriverKey]` Stable driver-category identifier — what is dragging the line, or one of its conversations, down. - `low_engagement` — The conversation is one-sided: several messages sent, few or no replies back. Pause or rework outreach where recipients are not replying, and lead with messages that invite a response. Conversation-level: it appears on `evidence.unhealthy_chats[].driver_keys`, never in `drivers`. - `overall_conversation_health` — A large share of the line's active conversations are trending unhealthy. Fix the unhealthy conversations first — review their content and timing, and whether recipients are engaging. - `volume_spike` — The line's daily sending volume jumped far above its own normal level while few recipients were replying, or exceeded the recommended daily volume for a single line. Ramp volume gradually instead of spiking, prioritize people who have already engaged with you, and spread sustained high volume across additional lines. - `new_conversation_rate` — The line is starting too many brand-new conversations in a single day. Spread new conversations out over time instead of starting many at once. - `opt_out_handling` — Recipients asked this line to stop. Honor every stop request immediately: send nothing further to that recipient unless they opt back in. Every send to them is rejected with `403` (error code `2024`), including a final courtesy message — to send one telling them they can reply to resume, set `override_optout: true` on that single request. - `flagged` — The line is currently restricted and its messages may not be reaching recipients. Move active traffic to a healthy line now, and let this one recover before sending more. - `other` — Fallback for a signal without dedicated partner copy. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `metric: Optional[str]` A specific observed figure when available; otherwise a short qualitative note. - `summary: Optional[str]` One plain-English sentence. - `evidence: Optional[ReputationEvidence]` The specific conversations behind the drivers, so partners can verify every claim against their own send logs. Each `chat_id` can be fetched via `GET /v3/chats/{chatId}` — its current health appears there. - `opt_out_chats: Optional[List[ReputationOptOutChat]]` Worst first — most messages sent after the stop request; honor these immediately. - `chat_id: Optional[str]` - `messages_after_stop: Optional[int]` Outbound messages sent after the recipient asked to stop. - `unhealthy_chats: Optional[List[ReputationUnhealthyChat]]` Up to 15, worst first. - `chat_id: Optional[str]` - `driver_keys: Optional[List[ReputationDriverKey]]` What is dragging this conversation down, in the same vocabulary as the report's drivers. Each key's meaning and the fix for it are documented on `ReputationDriverKey`. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `status: Optional[Literal["AT_RISK", "CRITICAL", "OPTED_OUT"]]` The conversation's current health — the same value `GET /v3/chats/{chatId}` reports for it. - `"AT_RISK"` - `"CRITICAL"` - `"OPTED_OUT"` - `primary_driver: Optional[str]` The `key` of the most important driver. Empty string when the line has nothing to act on — the report then carries a single reassurance action item. Its values are the `ReputationDriverKey` vocabulary — see that schema for what each means and what to do about it. - `severity: Optional[Literal["HEALTHY", "AT_RISK", "CRITICAL"]]` Current reputation of this phone line. - `HEALTHY` — The line is in good standing. Send normally. - `AT_RISK` — Warning signs on the line: engagement is low across many of its conversations, or it's starting too many brand-new conversations in a single day — and a spike in send volume can add to either. Slow the line's send pace, avoid opening many new conversations at once, and review your messaging patterns. - `CRITICAL` — Strong signals that messages from this line aren't landing well. Pause outbound on the line until it recovers. Defaults to `HEALTHY` for lines that have not yet been scored. - `"HEALTHY"` - `"AT_RISK"` - `"CRITICAL"` - `summary_markdown: Optional[str]` Deterministic markdown rendering of this report, suitable for feeding directly to automated systems and AI agents as investigation context. Rendered from the structured fields above, which remain the source of truth. ### Reputation Unhealthy Chat - `class ReputationUnhealthyChat: …` - `chat_id: Optional[str]` - `driver_keys: Optional[List[ReputationDriverKey]]` What is dragging this conversation down, in the same vocabulary as the report's drivers. Each key's meaning and the fix for it are documented on `ReputationDriverKey`. - `"low_engagement"` - `"overall_conversation_health"` - `"volume_spike"` - `"new_conversation_rate"` - `"opt_out_handling"` - `"flagged"` - `"other"` - `status: Optional[Literal["AT_RISK", "CRITICAL", "OPTED_OUT"]]` The conversation's current health — the same value `GET /v3/chats/{chatId}` reports for it. - `"AT_RISK"` - `"CRITICAL"` - `"OPTED_OUT"` ### Phone Number List Response - `class PhoneNumberListResponse: …` - `phone_numbers: List[PhoneNumber]` List of phone numbers assigned to the partner - `id: str` Unique identifier for the phone number - `phone_number: str` Phone number in E.164 format - `reputation: PhoneNumberReputation` **[BETA]** Current reputation for a phone line. Always present — lines start at `HEALTHY` and may shift based on aggregate engagement and delivery signals across all conversations on the line. Unlike chat health, line reputation does not include `opted_out` — opt-out applies to individual recipients, not the whole line. See the [Phone Reputation guide](/channel/imessage/guides/phone-numbers/phone-reputation) for what each status means and how to react. - `doc_url: str` Deep-link to the relevant section of the Phone Reputation guide for this status. - `status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]` Current reputation of this phone line. - `HEALTHY` — The line is in good standing. Send normally. - `AT_RISK` — Warning signs on the line: engagement is low across many of its conversations, or it's starting too many brand-new conversations in a single day — and a spike in send volume can add to either. Slow the line's send pace, avoid opening many new conversations at once, and review your messaging patterns. - `CRITICAL` — Strong signals that messages from this line aren't landing well. Pause outbound on the line until it recovers. Defaults to `HEALTHY` for lines that have not yet been scored. - `"HEALTHY"` - `"AT_RISK"` - `"CRITICAL"` - `forwarding_number: Optional[str]` The forwarding number associated with this phone number, in E.164 format. Null when no forwarding number is configured. ### Phone Number Update Response - `class PhoneNumberUpdateResponse: …` - `id: str` Unique identifier for the phone number - `forwarding_number: Optional[str]` The forwarding number after the update. Null when cleared. - `phone_number: str` Phone number in E.164 format