OdyOdy Tulong

Gumawa nang ligtas gamit ang test mode

Na-update Mon Aug 17 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

Ang mga test-mode API key (ody_test_…) ay gumagana nang eksakto tulad ng mga live key maliban sa anumang gugugol ng pera o makakarating sa labas ng mundo ay simulated — pagpapadala ng mensahe, pagbili ng numero, outbound AI calls, pag-publish ng agent, at 10DLC registrations (na tumatakbo sa mock mode) — na ginagawang perpekto ang mga ito para sa development at CI.

Bago ka magsimula

  • Dapat kang maging admin o may-ari ng workspace para makagawa ng mga key.
  • Alamin kung ano ang ginagawa at hindi inihihiwalay ng test mode: ang isang test key ay gumagana laban sa iyong tunay na data ng workspace. Ang paggawa, pag-update, at pagtanggal ng contact ay totoo, ang pagbabago ng status ng pag-uusap ay totoo, at ang pag-save ng draft ng agent (PATCH /v1/api/agent) ay totoo. Ang simulated ay ang paggasta: mga pagpapadala, pagbili ng numero, outbound AI calls, pag-publish ng agent, at 10DLC filings.

Hakbang-hakbang

  1. I-click ang Settings sa sidebar, pagkatapos ay Developer API.

  2. Punan ang form ng paggawa gaya ng dati — pangalan at scopes (tingnan ang Kunin ang iyong Ody API key).

  3. Sa ilalim ng Key type, piliin ang Test. Kinukumpirma ito ng pahiwatig: ang mga test key ay nagbabasa ng tunay na data ngunit hindi kailanman nagpapadala ng tunay na text — ang mga pagpapadala ay naitala bilang simulated.

  4. I-click ang Create key at kopyahin ang ody_test_… secret mula sa one-time banner.

  5. Gamitin ito nang eksakto tulad ng isang live key — parehong base URL, endpoints, scopes, at rate limits:

curl https://api.ody.co/v1/api/messages \
  -H "Authorization: Bearer ody_test_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+15125550123","body":"CI smoke test"}'

Ang tugon ay isang normal na 201 na may "simulated": true, at ang mensahe ay lumalabas sa thread na may deliveryStatus: "simulated".

Ano ang magkapareho, ano ang simulated

Pag-uugali Gamit ang ody_test_… key
Pagbabasa ng mga contact, pag-uusap, tawag, numero Tunay na data, magkapareho sa live
Paggawa/pag-update/pagtanggal ng mga contact Tunay — binabago ang iyong workspace
Pagtatakda ng status ng pag-uusap Tunay
POST /v1/api/messages / MCP send_message Simulated — naitala, hindi kailanman naipadala
POST /v1/api/numbers / MCP buy_number Simulated"simulated": true, walang na-order, na-provision, o na-charge
POST /v1/api/calls / MCP place_call Simulated — isang sim_… call id, walang na-dial, walang nagamit na credits
POST /v1/api/agent/publish Simulated — ang iyong config ay nananatiling draft, walang nagiging live
PATCH /v1/api/agent (draft saves) Tunay — pareho sa live
POST /v1/api/messaging/registration Mock mode — tumatakbo ang buong 10DLC pipeline, ngunit walang isinumite sa registry at walang bayad
Scopes, rate limits, errors, pagination, idempotency Magkapareho sa live
Pamamahala ng Webhook endpoint Tunay na endpoints, pareho sa live

Sa listahan ng key, ang mga test key ay nagpapakita ng Test badge at isang ody_test_…WXYZ na pahiwatig upang hindi mo sila malito sa mga live key.

Paggamit ng test mode sa CI

  • Gumawa ng nakalaang test key bawat pipeline (halimbawa "GitHub Actions") upang maaari mo itong bawiin nang hiwalay at manatiling makabuluhan ang column na "huling ginamit".
  • I-imbak ito bilang isang CI secret (hal. ODY_API_KEY) — hindi nagbabago ang iyong code sa pagitan ng mga environment, tanging ang key lamang.
  • I-assert ang simulated: true sa mga tugon sa pagpapadala upang mahuli ang isang live key na aksidenteng na-configure sa CI.
  • Tandaan na ang pagsusulat ng contact ay totoo: ituro ang CI sa isang nakalaang workspace, o linisin ang mga contact na ginawa ng iyong mga test.

Mga Kaugnay na Artikulo

Mga madalas itanong

Gumagamit ba ang mga test key ng hiwalay na sandbox workspace?

Hindi — ang isang test key ay nagbabasa at nagsusulat ng iyong tunay na data ng workspace. Ang mga pagpapadala ng mensahe, pagbili ng numero, outbound AI calls, pag-publish ng agent, at 10DLC filings ay simulated; ang lahat ng iba pa ay gumagana nang eksakto tulad ng isang live key.

Paano ko malalaman kung ang isang mensahe ay simulated?

Ang tugon sa pagpapadala ay naglalaman ng "simulated": true, at ang naitalang mensahe ay may deliveryStatus na "simulated" sa halip na queued/sent/delivered.

Gumagana ba ang mga test key sa MCP?

Oo. Ikonekta ang isang AI assistant gamit ang ody_test_ key at ang bawat tool ay gagana nang normal, ngunit ang send_message ay magtatala ng simulated na mensahe sa halip na mag-text sa sinuman.

Higit pa sa Developer API