python-slackclient/docs/basic_usage.html at master · dvarrazzo/python-slackclient

History

572 lines (549 loc) · 43.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

<!DOCTYPE html>

<head>

<meta

http-equiv="Content-Type"

content="text/html; charset=utf-8"

<title>Basic Usage — Slack Developer Kit for Python</title>

(function(w, d, s, l, i) {

w[l] = w[l] || [];

w[l].push({

'gtm.start': new Date().getTime(),

event: 'gtm.js'

});

var f = d.getElementsByTagName(s)[0],

j = d.createElement(s),

dl = l != 'dataLayer' ? '&l=' + l : '';

j.async = true;

j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;

f.parentNode.insertBefore(j, f);

})(window, document, 'script', 'dataLayer', 'GTM-KFZ5MK7');

</script>

<link

href="https://a.slack-edge.com/4f227/style/rollup-slack_kit_legacy_adapters.css"

rel="stylesheet"

type="text/css"

<link

href="https://a.slack-edge.com/3e02c0/style/rollup-api_site.css"

rel="stylesheet"

type="text/css"

<link

rel="stylesheet"

href="./_static/default.css"

type="text/css"

<link

rel="stylesheet"

href="./_static/pygments.css"

type="text/css"

<link

rel="stylesheet"

href="./_static/docs.css"

type="text/css"

<link

id="favicon"

rel="shortcut icon"

href="https://a.slack-edge.com/4f28/img/icons/favicon-32.png"

type="image/png"

<link

rel="top"

title="Slack Developer Kit for Python 1.0.1 documentation"

href="index.html"

</head>

<noscript

><iframe

src="https://www.googletagmanager.com/ns.html?id=GTM-KFZ5MK7"

height="0"

width="0"

style="display:none;visibility:hidden"

></iframe

></noscript>

</a>

href="https://api.slack.com/"

id="header_logo"

class="api hide_on_mobile"

style="float:left; display: inline-block;"

<img

alt="Slack API"

src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png"

style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;"

</a>

<span

style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold;"

<a style="color: #555459;" href="./index.html">Slack Developer Kit for Python</a>

href="https://github.com/SlackAPI/python-slackclient"

class="btn header_btn float_right"

data-qa="go_to_slack"

>Go to GitHub</a

</div>

</header>

<li class="toctree-l1"><a class="reference internal" href="index.html">Slack Developer Kit for Python</a></li>

<li class="toctree-l1"><a class="reference internal" href="auth.html">Tokens & Authentication</a><ul>

<li class="toctree-l2"><a class="reference internal" href="auth.html#keeping-tokens-safe">Keeping tokens safe</a></li>

<li class="toctree-l2"><a class="reference internal" href="auth.html#single-workspace-install">Single Workspace Install</a></li>

<li class="toctree-l2"><a class="reference internal" href="auth.html#multiple-workspace-install">Multiple Workspace Install</a></li>

</ul>

</li>

<li class="toctree-l1 current"><a class="current reference internal" href="#">Basic Usage</a><ul>

<li class="toctree-l2"><a class="reference internal" href="#sending-a-message">Sending a message</a></li>

<li class="toctree-l2"><a class="reference internal" href="#formatting-with-block-kit">Formatting with Block Kit</a></li>

<li class="toctree-l2"><a class="reference internal" href="#threading-messages">Threading Messages</a></li>

<li class="toctree-l2"><a class="reference internal" href="#updating-a-message">Updating a message</a></li>

<li class="toctree-l2"><a class="reference internal" href="#deleting-a-message">Deleting a message</a></li>

<li class="toctree-l2"><a class="reference internal" href="#opening-a-modal">Opening a modal</a></li>

<li class="toctree-l2"><a class="reference internal" href="#updating-and-pushing-modals">Updating and pushing modals</a></li>

<li class="toctree-l2"><a class="reference internal" href="#emoji-reactions">Emoji reactions</a></li>

<li class="toctree-l2"><a class="reference internal" href="#listing-channels">Listing channels</a></li>

<li class="toctree-l2"><a class="reference internal" href="#getting-a-channel-s-info">Getting a channel’s info</a></li>

<li class="toctree-l2"><a class="reference internal" href="#joining-a-channel">Joining a channel</a></li>

<li class="toctree-l2"><a class="reference internal" href="#leaving-a-channel">Leaving a channel</a></li>

<li class="toctree-l2"><a class="reference internal" href="#listing-team-members">Listing team members</a></li>

<li class="toctree-l2"><a class="reference internal" href="#uploading-files">Uploading files</a></li>

<li class="toctree-l2"><a class="reference internal" href="#web-api-rate-limits">Web API Rate Limits</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="conversations.html">Conversations API</a><ul>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#direct-messages">Direct messages</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#creating-channels">Creating channels</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-more-information">Getting more information</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#listing-conversations">Listing conversations</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#leaving-a-conversation">Leaving a conversation</a></li>

<li class="toctree-l2"><a class="reference internal" href="conversations.html#getting-members">Getting members</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="real_time_messaging.html">Real Time Messaging (RTM)</a><ul>

<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#connecting-to-the-rtm-api">Connecting to the RTM API</a></li>

<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-start-vs-rtm-connect">rtm.start vs rtm.connect</a></li>

<li class="toctree-l2"><a class="reference internal" href="real_time_messaging.html#rtm-events">RTM Events</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>

<li class="toctree-l2"><a class="reference internal" href="faq.html#i-found-a-bug">I found a bug!</a></li>

<li class="toctree-l2"><a class="reference internal" href="faq.html#there-s-a-feature-missing">There’s a feature missing!</a></li>

<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-contribute">How do I contribute?</a></li>

<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-compile-the-documentation">How do I compile the documentation?</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>

< 8000 /div>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>

<li class="toctree-l2"><a class="reference internal" href="about.html#product-name">Slack Developer Kit for Python</a></li>

</ul>

</li>

</ul>

<li><a href="https://github.com/SlackAPI/python-slackclient/blob/master/LICENSE">License</a></li>

<li><a href="https://slackhq.github.io/code-of-conduct">Code of Conduct</a></li>

<li><a href="https://github.com/slackapi/python-slackclient/blob/master/.github/contributing.md">Contributing</a></li>

<li><a href="https://docs.google.com/a/slack-corp.com/forms/d/e/1FAIpQLSfzjVoCM7ohBnjWf7eDYQxzti1EPpinsIJQA5RAUBwJKRUQHg/viewform">Contributor License Agreement</a></li>

</ul>

Made with by Slack and our Lovely

Community

</div>

</nav>

<h1>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h1>

The Slack Web API allows you to build applications that interact with Slack in more complex ways than the integrations we provide out of the box.

Access Slack’s API methods requires an OAuth token – see the <a class="reference external" href="auth">Tokens & Authentication</a> section for more on how Slack uses OAuth tokens as well as best practices.

<a class="reference external" href="https://api.slack.com/methods">Each of these API methods</a> is fully documented on our developer site at api.slack.com

<h2>Sending a message<a class="headerlink" href="#sending-a-message" title="Permalink to this headline">¶</a></h2>

One of the primary uses of Slack is posting messages to a channel using the channel ID or as a DM to another person using their user ID. This method will handle either a channel ID or a user ID passed to the <code class="docutils literal notranslate">channel</code> parameter.

<div class="highlight-python notranslate"><div class="highlight"><pre>import os

import slack

slack_token = os.environ["SLACK_API_TOKEN"]

client = slack.WebClient(token=slack_token)

client.chat_postMessage(

channel="C0XXXXXX",

text="Hello from your app! :tada:"

)

</pre></div>

</div>

Sending an ephemeral message, which is only visible to an assigned user in a specified channel, is nearly the same

as sending a regular message, but with an additional <code class="docutils literal notranslate">user</code> parameter.

<div class="highlight-python notranslate"><div class="highlight"><pre>import os

import slack

client.chat_postEphemeral(

channel="C0XXXXXX",

text="Hello silently from your app! :tada:",

user="U0XXXXXXX"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/chat.postEphemeral">chat.postEphemeral</a> for more info.

</div>

<h2>Formatting with Block Kit<a class="headerlink" href="#formatting-with-block-kit" title="Permalink to this headline">¶</a></h2>

Messages posted from apps can contain more than just text, though. They can include full user interfaces composed of <a class="reference external" href="https://api.slack.com/block-kit">blocks</a>.

The chat.postMessage method takes an optional blocks argument that allows you to customize the layout of a message. Blocks specified in a single object literal, so just add additional keys for any optional argument.

To send a message to a channel, use the channel’s ID. For IMs, use the user’s ID.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.chat_postMessage(

channel="C0XXXXXX",

blocks=[

{

"type": "section",

"text": {

"type": "mrkdwn",

"text": "Danny Torrence left the following review for your property:"

}

},

{

"type": "section",

"text": {

"type": "mrkdwn",

"text": "<https://example.com|Overlook Hotel> \n :star: \n Doors had too many axe holes, guest in room " +

"237 was far too rowdy, whole place felt stuck in the 1920s."

},

"accessory": {

"type": "image",

"image_url": "https://images.pexels.com/photos/750319/pexels-photo-750319.jpeg",

"alt_text": "Haunted hotel image"

}

},

{

"type": "section",

"fields": [

{

"type": "mrkdwn",

"text": "*Average Rating*\n1.0"

}

]

}

]

)

</pre></div>

</div>

Note: You can use the <a class="reference external" href="https://api.slack.com/tools/block-kit-builder">Block Kit Builder</a> to prototype your message’s look and feel.

</div>

<h2>Threading Messages<a class="headerlink" href="#threading-messages" title="Permalink to this headline">¶</a></h2>

Threaded messages are a way of grouping messages together to provide greater context. You can reply to a thread or start a new threaded conversation by simply passing the original message’s <code class="docutils literal notranslate">ts</code> ID in the <code class="docutils literal notranslate">thread_ts</code> attribute when posting a message. If you’re replying to a threaded message, you’ll pass the <cite>thread_ts</cite> ID of the message you’re replying to.

A channel or DM conversation is a nearly linear timeline of messages exchanged between people, bots, and apps. When one of these messages is replied to, it becomes the parent of a thread. By default, threaded replies do not appear directly in the channel, instead relegated to a kind of forked timeline descending from the parent message.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.chat_postMessage(

channel="C0XXXXXX",

text="Hello from your app! :tada:",

thread_ts="1476746830.000003"

)

</pre></div>

</div>

By default, <code class="docutils literal notranslate">reply_broadcast</code> is set to <code class="docutils literal notranslate">False</code>. To indicate your reply is germane to all members of a channel, and therefore a notification of the reply should be posted in-channel, set the <code class="docutils literal notranslate">reply_broadcast</code> to <code class="docutils literal notranslate">True</code>.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.chat_postMessage(

channel="C0XXXXXX",

text="Hello from your app! :tada:",

thread_ts="1476746830.000003",

reply_broadcast=True

)

</pre></div>

</div>

Note: While threaded messages may contain attachments and message buttons, when your reply is broadcast to the

channel, it’ll actually be a reference to your reply, not the reply itself.

So, when appearing in the channel, it won’t contain any attachments or message buttons. Also note that updates and

deletion of threaded replies works the same as regular messages.

See the <a class="reference external" href="https://api.slack.com/docs/message-threading#forking_conversations">Threading messages together</a>

article for more information.

</div>

<h2>Updating a message<a class="headerlink" href="#updating-a-message" title="Permalink to this headline">¶</a></h2>

Let’s say you have a bot which posts the status of a request. When that request changes, you’ll want to update the message to reflect it’s state.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.chat_update(

ts="1476746830.000003",

channel="C0XXXXXX",

text="updates from your app! :tada:"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/chat.update">chat.update</a> for formatting options and some special considerations when calling this with a bot user.

</div>

<h2>Deleting a message<a class="headerlink" href="#deleting-a-message" title="Permalink to this headline">¶</a></h2>

Sometimes you need to delete things.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.chat_delete(

channel="C0XXXXXX",

ts="1476745373.000002"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/chat.delete">chat.delete</a> for more info.

</div>

<h2>Opening a modal<a class="headerlink" href="#opening-a-modal" title="Permalink to this headline">¶</a></h2>

Modals allow you to collect data from users and display dynamic information in a focused surface.

Modals use the same blocks that compose messages with the addition of an <cite>input</cite> block.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.views_open(

trigger_id="3213746830.000023",

view={

type: "modal",

callback_id: "view_identifier",

title: {

type: "plain_text",

text: "Modal title"

},

blocks: [

{

type: "input",

label: {

type: "plain_text",

text: "Input label"

},

element: {

type: "plain_text_input",

action_id: "value_indentifier"

}

]

}

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/views.open">views.open</a> more details and additional parameters.

</div>

<h2>Updating and pushing modals<a class="headerlink" href="#updating-and-pushing-modals" title="Permalink to this headline">¶</a></h2>

You can dynamically update a view inside of a modal by calling <cite>views.update</cite> and passing the view ID returned in the previous <cite>views.open</cite> call.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.views_update(

view_id="V123401"

view={

type: "modal",

callback_id: "view_identifier",

title: {

type: "plain_text",

text: "Modal title"

},

blocks: [

{

type: "section",

text: {

type: "plain_text",

text: "An updated modal, indeed"

}

]

}

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/views.update">views.update</a> for more info.

If you want to push a new view onto the modal instead of updating an existing view, reference the <a class="reference external" href="https://api.slack.com/methods/views.push">views.push</a> documentation.

</div>

<h2>Emoji reactions<a class="headerlink" href="#emoji-reactions" title="Permalink to this headline">¶</a></h2>

You can quickly respond to any message on Slack with an emoji reaction. Reactions can be used for any purpose: voting, checking off to-do items, showing excitement -— or just for fun.

This method adds a reaction (emoji) to an item (<code class="docutils literal notranslate">file</code>, <code class="docutils literal notranslate">file comment</code>, <code class="docutils literal notranslate">channel message</code>, <code class="docutils literal notranslate">group message</code>, or <code class="docutils literal notranslate">direct message</code>). One of file, file_comment, or the combination of channel and timestamp must be specified.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.reactions_add(

channel="C0XXXXXXX",

name="thumbsup",

timestamp="1234567890.123456"

)

</pre></div>

</div>

Removing an emoji reaction is basically the same format, but you’ll use <code class="docutils literal notranslate">reactions.remove</code> instead of <code class="docutils literal notranslate">reactions.add</code>

<div class="highlight-python notranslate"><div class="highlight"><pre>client.reactions_remove(

channel="C0XXXXXXX",

name="thumbsup",

timestamp="1234567890.123456"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/reactions.add">reactions.add</a> and <a class="reference external" href="https://api.slack.com/methods/reactions.remove">reactions.remove</a> for more info.

</div>

<h2>Listing channels<a class="headerlink" href="#listing-channels" title="Permalink to this headline">¶</a></h2>

At some point, you’ll want to find out what channels are available to your app. This is how you get that list.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.channels_list()

</pre></div>

</div>

Archived channels are included by default. You can exclude them by passing <code class="docutils literal notranslate">exclude_archived=1</code> to your request.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.channels_list(

exclude_archived=1

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/channels.list">channels.list</a> for more info.

</div>

<h2>Getting a channel’s info<a class="headerlink" href="#getting-a-channel-s-info" title="Permalink to this headline">¶</a></h2>

Once you have the ID for a specific channel, you can fetch information about that channel.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.channels_info(,

channel="C0XXXXXXX"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/channels.info">channels.info</a> for more info.

</div>

<h2>Joining a channel<a class="headerlink" href="#joining-a-channel" title="Permalink to this headline">¶</a></h2>

Channels are the social hub of most Slack teams. Here’s how you hop into one:

<div class="highlight-python notranslate"><div class="highlight"><pre>client.channels_join(

channel="C0XXXXXXY"

)

</pre></div>

</div>

If you are already in the channel, the response is slightly different.

<code class="docutils literal notranslate">already_in_channel</code> will be true, and a limited <code class="docutils literal notranslate">channel</code> object will be returned. Bot users cannot join a channel on their own, they need to be invited by another user.

See <a class="reference external" href="https://api.slack.com/methods/channels.join">channels.join</a> for more info.

</div>

<h2>Leaving a channel<a class="headerlink" href="#leaving-a-channel" title="Permalink to this headline">¶</a></h2>

Maybe you’ve finished up all the business you had in a channel, or maybe you

joined one by accident. This is how you leave a channel.

<div class="highlight-python notranslate"><div class="highlight"><pre>client.channels_leave(

channel="C0XXXXXXX"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/channels.leave">channels.leave</a> for more info.

</div>

<h2>Listing team members<a class="headerlink" href="#listing-team-members" title="Permalink to this headline">¶</a></h2>

<div class="highlight-python notranslate"><div class="highlight"><pre>client.users_list()

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/users.list">users.list</a> for more info.

</div>

<h2>Uploading files<a class="headerlink" href="#uploading-files" title="Permalink to this headline">¶</a></h2>

<div class="highlight-python notranslate"><div class="highlight"><pre>client.files_upload(

channels="C3UKJTQAC",

file="files.pdf",

title="Test upload"

)

</pre></div>

</div>

See <a class="reference external" href="https://api.slack.com/methods/files.upload">files.upload</a> for more info.

</div>

<h2>Web API Rate Limits<a class="headerlink" href="#web-api-rate-limits" title="Permalink to this headline">¶</a></h2>

When posting messages to a channel, Slack allows applications to send no more than one message per channel per second. We allow bursts over that limit for short periods. However, if your app continues to exceed the limit over a longer period of time it will be rate limited. Different API methods have other rate limits – be sure to <a class="reference external" href="https://api.slack.com/docs/rate-limits">check the limits</a> and test that your application has a graceful fallback if it should hit those limits.

If you go over these limits, Slack will start returning a HTTP 429 Too Many Requests error, a JSON object containing the number of calls you have been making, and a Retry-After header containing the number of seconds until you can retry.

Here’s a very basic example of how one might deal with rate limited requests.

<div class="highlight-python notranslate"><div class="highlight"><pre>import slack

import time

# Simple wrapper for sending a Slack message

def send_slack_message(channel, message):

return client.chat_postMessage(

channel=channel,

text=message

)

# Make the API call and save results to `response`

response = send_slack_message("C0XXXXXX", "Hello, from Python!")

# Check to see if the message sent successfully.

# If the message succeeded, `response["ok"]`` will be `True`

if response["ok"]:

print(f"Message posted successfully: {response["message"]["ts"]}")

# If the message failed, check for rate limit headers in the response

elif response["ok"] is False and response["headers"]["Retry-After"]:

# The `Retry-After` header will tell you how long to wait before retrying

delay = int(response["headers"]["Retry-After"])

print("Rate limited. Retrying in " + str(delay) + " seconds")

time.sleep(delay)

send_slack_message(message, channel)

</pre></div>

</div>

See the documentation on <a class="reference external" href="https://api.slack.com/docs/rate-limits">Rate Limiting</a> for more info.

</div>

</div>

</div>

</footer>

window.ga =

window.ga ||

function() {

(ga.q = ga.q || []).push(arguments);

};

ga.l = +new Date();

ga('create', 'UA-56978219-13', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

basic_usage.html

Latest commit

History

basic_usage.html

File metadata and controls