From 8d3239f639dfd76cee0d695615e58992aa01f400 Mon Sep 17 00:00:00 2001
From: Eliot Hsu <eliothsu@users.noreply.github.com>
Date: Tue, 31 Oct 2023 18:31:53 -0700
Subject: [PATCH] docs update (#429)

* docs update

* fix
---
 docs/do-not-call-detection.mdx | 52 ++++++++++++++++++++++++++++++++++
 docs/mint.json                 |  3 +-
 2 files changed, 54 insertions(+), 1 deletion(-)
 create mode 100644 docs/do-not-call-detection.mdx

diff --git a/docs/do-not-call-detection.mdx b/docs/do-not-call-detection.mdx
new file mode 100644
index 000000000..c93338180
--- /dev/null
+++ b/docs/do-not-call-detection.mdx
@@ -0,0 +1,52 @@
+---
+title: "[Beta] Do Not Call detection"
+description: "Configure whether or not to run automatic estimated Do Not Call analysis"
+---
+
+The Vocode API allows you to configure whether or not to run automatic rudimentary detection
+on outbound calls as to whether or not the receiving party has indicated they would like to
+be placed on a Do Not Call list. Additionally, if Do Not Call analysis was run on a call,
+the result will be populated into a field on the Call object returned from the Get Call endpoint.
+
+By default, if the `run_do_not_call_detection` argument is not supplied, Vocode will not run
+Do Not Call detection.
+
+# Example 1: Run Do Not Call detection on an outbound call, and retrieve the result
+
+The `run_do_not_call_detection` parameter on outbound call creation defines whether
+or not to run rudimentary Do Not Call analysis.
+
+```python
+from vocode import CreateCallAgentParams
+
+vocode_client.calls.create_call(
+    from_number="<YOUR VOCODE NUMBER>",
+    to_number="15555555555",
+    agent=CreateCallAgentParams(
+        prompt=Prompt(
+            content="Ask Eliot if the sun is on today"
+        ),
+    ),
+    run_do_not_call_detection=True
+)
+```
+
+After the call has completed, we can query for calls as usual, and find the returned Call object
+has the Do Not Call detection result set:
+
+```python Python
+vocode_client.calls.get_call(id="CALL_ID")
+```
+
+returning:
+
+```json
+{
+  "id": "call_id",
+  "to_number": "123456789",
+  "from_number": "123456789",
+  ...
+  "do_not_call_result": true,
+  ...
+}
+```
diff --git a/docs/mint.json b/docs/mint.json
index c51c218c1..37518f38f 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -174,7 +174,8 @@
         "injecting-context",
         "machine-detection",
         "ivr-navigation",
-        "hipaa-compliance"
+        "hipaa-compliance",
+        "do-not-call-detection"
       ]
     }
   ],